diff options
author | Gerald Combs <gerald@wireshark.org> | 2016-03-17 17:19:18 -0700 |
---|---|---|
committer | Gerald Combs <gerald@wireshark.org> | 2016-03-18 23:26:51 +0000 |
commit | a1837263708cda91caec1691a469ad1415924a8e (patch) | |
tree | 80fb5b584d2ca5617eff13261140595d232d5548 /docbook | |
parent | bf1c8b5617a1d5e679ba28f9203bc893e2c698a8 (diff) |
DocBook: Don't require xmllint.
Remove dependencies on xmllint. We don't write DocBook by hand any more
and we haven't used it in a long time in the CMake builds.
Change-Id: Ic07f03b00c4554c058eece0462b0925d565b6da1
Reviewed-on: https://code.wireshark.org/review/14506
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/CMakeLists.txt | 13 | ||||
-rw-r--r-- | docbook/Makefile.am | 28 | ||||
-rw-r--r-- | docbook/Makefile.common | 1 | ||||
-rw-r--r-- | docbook/Makefile.nmake | 22 | ||||
-rw-r--r-- | docbook/README.txt | 31 |
5 files changed, 8 insertions, 87 deletions
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt index cd5204bf0e..6424810242 100644 --- a/docbook/CMakeLists.txt +++ b/docbook/CMakeLists.txt @@ -21,7 +21,6 @@ find_package( LYNX ) find_package( XSLTPROC ) -find_package( XMLLINT ) if(ENABLE_CHM_GUIDES) find_package( HTMLHelp ) endif() @@ -333,12 +332,6 @@ endif() # User's Guide chain. if(ENABLE_HTML_GUIDES) - # a2x always generates valid XML, *right*? - #VALIDATE_XML( - # wsug.validated - # user-guide.xml - #) - XML2HTML( user_guide wsug @@ -415,12 +408,6 @@ endif() # Developer's Guide chain. if(ENABLE_HTML_GUIDES) - # a2x always generates valid XML, *right*? - #VALIDATE_XML( - # wsdg.validated - # developer-guide.xml - #) - XML2HTML( developer_guide wsdg diff --git a/docbook/Makefile.am b/docbook/Makefile.am index 304c809e16..f4e6fa2898 100644 --- a/docbook/Makefile.am +++ b/docbook/Makefile.am @@ -41,9 +41,9 @@ all: $(ALL_TARGETS) # Wireshark User Guide if HAVE_FOP -WSUG_TARGETS=wsug.validated wsug_html_chunked wsug_html user-guide-a4.pdf user-guide-us.pdf +WSUG_TARGETS=wsug_html_chunked wsug_html user-guide-a4.pdf user-guide-us.pdf else -WSUG_TARGETS=wsug.validated wsug_html_chunked wsug_html +WSUG_TARGETS=wsug_html_chunked wsug_html endif wsug: $(WSUG_TARGETS) @@ -57,16 +57,6 @@ user-guide.xml: user-guide.asciidoc $(WSUG_FILES) --destination-dir=$(builddir) \ $< -# validate the content -wsug.validated: $(WSUG_SOURCE) -if HAVE_XMLLINT - @ echo --- WSUG - VALIDATING XML --- - $(XMLLINT) --path .:$(srcdir) --valid --noout $< - touch $@ -else - @ echo --- WSUG - SKIP VALIDATION --- -endif - # create html single page file wsug_html: wsug_html/index.html @@ -118,9 +108,9 @@ wsluarm: make-wsluarm.pl $(WSLUA_MODULES) # Wireshark Developer Guide if HAVE_A2X if HAVE_FOP -WSDG_TARGETS=wsdg.validated wsdg_html_chunked wsdg_html developer-guide-a4.pdf developer-guide-us.pdf +WSDG_TARGETS=wsdg_html_chunked wsdg_html developer-guide-a4.pdf developer-guide-us.pdf else -WSDG_TARGETS=wsdg.validated wsdg_html_chunked wsdg_html +WSDG_TARGETS=wsdg_html_chunked wsdg_html endif else WSDG_TARGETS= @@ -137,16 +127,6 @@ developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES) --destination-dir=$(builddir) \ $< -# validate the content -wsdg.validated: $(WSDG_SOURCE) -if HAVE_XMLLINT - @ echo --- WSDG - VALIDATING XML --- - $(XMLLINT) --path .:wsluarm_src:$(srcdir) --valid --noout $< - touch $@ -else - @ echo --- WSDG - SKIP VALIDATION --- -endif - # create html single page file wsdg_html: wsdg_html/index.html wsluarm diff --git a/docbook/Makefile.common b/docbook/Makefile.common index 228ac4cbca..8401657692 100644 --- a/docbook/Makefile.common +++ b/docbook/Makefile.common @@ -239,7 +239,6 @@ CLEANFILES = \ *.hhc \ *.hhp \ *.pdf \ - *.validated \ $(WSDG_GENERATED_SOURCE) \ $(WSUG_GENERATED_SOURCE) \ wsdg_chm \ diff --git a/docbook/Makefile.nmake b/docbook/Makefile.nmake index 21c018fda4..5d07b0636c 100644 --- a/docbook/Makefile.nmake +++ b/docbook/Makefile.nmake @@ -34,13 +34,13 @@ A2X_TEXT_OPTS=$(A2X_TEXT_OPTS) --lynx # -- (Public) targets ------------------------------------------------------- # Make all (default) -all: all_x +all: wsug_x wsdg_x release_notes_x # Make only the WSUG -wsug: wsug.validated wsug_x +wsug: wsug_x # Make only the WSDG -wsdg: wsdg.validated wsdg_x +wsdg: wsdg_x # Make only the release notes release_notes: release_notes_x @@ -53,10 +53,6 @@ distclean: clean maintainer-clean: distclean -# -- All ------------------------------------------------------------------------------- - -all_x: wsug.validated wsdg.validated wsug_x wsdg_x release_notes_x - # -- User Guide ------------------------------------------------------------------------ wsug_x: wsug_html_chunked wsug_html user-guide-a4.pdf user-guide-us.pdf user-guide.chm @@ -74,12 +70,6 @@ user-guide.xml: user-guide.asciidoc $(WSUG_FILES) user-guide-docinfo.xml user-guide.asciidoc << -# validate the content -wsug.validated: $(WSUG_SOURCE) - @ echo --- WSUG - VALIDATING XML --- - $(XMLLINT) --valid --noout user-guide.xml - touch $@ - # create html single page file wsug_html: wsug_html\index.html @@ -160,12 +150,6 @@ developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES) wsluarm developer-gu developer-guide.asciidoc << -# validate the content -wsdg.validated: $(WSDG_SOURCE) - @ echo --- WSDG - VALIDATING XML --- - $(XMLLINT) --valid --noout developer-guide.xml - touch $@ - # create html single page file wsdg_html: wsdg_html\index.html diff --git a/docbook/README.txt b/docbook/README.txt index 7b56f62dd1..88fec4b47d 100644 --- a/docbook/README.txt +++ b/docbook/README.txt @@ -52,21 +52,13 @@ http://xmlsoft.org/xslt/ Available as a package for Linux / Cygwin. Supplied with Mac OS X Panther and later. -xmllint -------- -Needed to validate if the .xml files conform to the Docbook/XML DTD. -Part of libxml2: -http://xmlsoft.org/ -Available as a package for Linux / Cygwin. -Supplied with Mac OS X Panther and later. - FOP processor (for PDF generation only) --------------------------------------- FOP processor from the apache project: http://xml.apache.org/fop/ FOP is a Java program, so you need to have a Java environment installed. -The makefiles look for fop-1.0 in the docbook directory. You can change +The makefiles look for fop-2.1 in the docbook directory. You can change this location by setting the FOP environment variable or by changing config.nmake. @@ -81,17 +73,6 @@ http://offo.sourceforge.net/hyphenation/. Different pattern files have different licenses. The English patterns may have restrictions on commercial use. -JIMI (for PDF generation) -------------------------- -Jimi is a JAVA class library for managing images. -In addition to FOP, be sure to also have installed JAI and/or jimi to be able -to use/convert the PNG graphics files. The FOP release note webpage tells how -to do it: -download jimi from: -http://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-java-client-419417.html -then extract the archive, then copy JimiProClasses.zip to FOP's lib dir and -rename it to jimi-1.0.jar. - AsciiDoc -------- Text documentation format and conversion suite: http://asciidoc.org/. AsciiDoc @@ -153,14 +134,12 @@ Tool/File Cygwin Package Opt./Mand. Comments --------- -------------- ---------- -------- asciidoc Doc/asciidoc M cygwin python is a dependency and will also be installed (if not installed) xsltproc: Libs/libxslt M -xmllint: Libs/libxml2 M xsl stylesheets: Text/docbook-xsl M docbook.xsl, chunk.xsl and htmlhelp.xsl docbookx.dtd: Text/docbook-xml42 M a later version may be required (e.g. Doc/docbook-xml45), depending on your asciidoc installation docbookx.dtd: Text/docbook-xml45 M current asciidoc installations require this lynx: Web/lynx M dblatex Text/dblatex O A number of dependencies will also be installed fop: - O URL: http://xml.apache.org/fop/ - install it into docbok\fop-1.x or wireshark_lib_dir\fop-1.x to use defaults from config.nmake -jimi: - O URL: http://java.sun.com/products/jimi/ - see above hhc: - O URL: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp zip: Archive/zip O getopt: Base/util-linux O Required to run "build-docbook-catalog" @@ -171,11 +150,9 @@ Packages for Suse 9.3 Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M -xmllint: libxml2 M xsl stylesheets: docbook-xsl-stylesheets M docbook.xsl and chunk.xsl docbookx.dtd: docbook_4 M fop: fop O -jimi: - O get it from http://java.sun.com/products/jimi/ - see above Packages for Gentoo @@ -187,14 +164,12 @@ Install it: emerge <package> Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M -xmllint: libxml2 M xsl stylesheets: docbook-xsl-stylesheets M docbook.xsl and chunk.xsl Necessary docbook catalogs are built automatically by portage in /etc/xml and /etc/sgml docbook.xsl and chunk.xsl using "/usr/bin/build-docbook-catalog". So docbook runs out of the box on Gentoo. docbookx.dtd: docbook-xml-dtd M fop: fop O Has a lot of JAVA dependencies. -jimi: sun-jimi O Used by fop. Quanta+ quanta or kdewebdev O Nice HTML/XML/SGML and Docbook editor with Syntaxhighlighting, Autocompletion, etc. Tip: The actual DTD version of Gentoo is 4.4, but wireshark docs still use 4.2. @@ -208,13 +183,11 @@ Packages for Fedora Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M -xmllint: libxml2 M xsl stylesheets: docbook-style-xsl M docbook.xsl and chunk.xsl docbookx.dtd: docbook-dtds M provides v4.1, v4.2, v4.3, v4.4 DTDs asciidoc: ascidoc M fop: fop O See above -jimi: - O get it from http://java.sun.com/products/jimi/ - see above Note: There are required dependencies (such as xml-common and sgml-common); yum is your friend for doing package installs including required @@ -226,13 +199,11 @@ Packages for Debian Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M -xmllint: libxml2-utils M xsl stylesheets: docbook-xsl M chunk.xsl: docbook-xsl M htmlhelp.xsl: docbook-xsl M docbookx.dtd: docbook-xml M fop: fop O See above -jimi: - O http://java.sun.com/products/jimi/ - see above |