diff options
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | Makefile.am | 1 | ||||
-rw-r--r-- | cmake/modules/FindXMLLINT.cmake | 73 | ||||
-rw-r--r-- | cmake/modules/FindXSLTPROC.cmake | 2 | ||||
-rw-r--r-- | config.nmake | 3 | ||||
-rw-r--r-- | configure.ac | 5 | ||||
-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 |
11 files changed, 8 insertions, 173 deletions
diff --git a/.gitignore b/.gitignore index b7875b896f..4b1af39b51 100644 --- a/.gitignore +++ b/.gitignore @@ -169,10 +169,8 @@ docbook/ws?g_html_chunked/ docbook/ws?g_chm/ docbook/release-notes-*.pdf docbook/release-notes.txt -docbook/wsdg.validated docbook/wsluarm docbook/wsluarm_src/ -docbook/wsug.validated wsar_html/ wsar_html.zip diff --git a/Makefile.am b/Makefile.am index 7197346a9d..1a70f64973 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1303,7 +1303,6 @@ EXTRA_DIST = \ cmake/modules/FindWinSparkle.cmake \ cmake/modules/FindWireshark.cmake \ cmake/modules/FindWSWinLibs.cmake \ - cmake/modules/FindXMLLINT.cmake \ cmake/modules/FindXSLTPROC.cmake \ cmake/modules/FindYACC.cmake \ cmake/modules/FindYAPP.cmake \ diff --git a/cmake/modules/FindXMLLINT.cmake b/cmake/modules/FindXMLLINT.cmake deleted file mode 100644 index aee58c80ff..0000000000 --- a/cmake/modules/FindXMLLINT.cmake +++ /dev/null @@ -1,73 +0,0 @@ -# -# - Find unix commands from cygwin -# This module looks for some usual Unix commands. -# - -INCLUDE(FindCygwin) - -FIND_PROGRAM(XMLLINT_EXECUTABLE - NAMES - xmllint - PATHS - ${CYGWIN_INSTALL_PATH}/bin - /bin - /usr/bin - /usr/local/bin - /sbin -) - -INCLUDE(FindPackageHandleStandardArgs) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(XMLLINT DEFAULT_MSG XMLLINT_EXECUTABLE) - -MARK_AS_ADVANCED(XMLLINT_EXECUTABLE) - -if (WIN32 AND NOT "${CYGWIN_INSTALL_PATH}" STREQUAL "" AND ${XMLLINT_EXECUTABLE} MATCHES "${CYGWIN_INSTALL_PATH}") - FIND_PROGRAM(CYGPATH_EXECUTABLE - NAMES cygpath - PATHS ${CYGWIN_INSTALL_PATH}/bin - ) - # XXX Duplicate of TO_A2X_COMPATIBLE_PATH - MACRO( TO_XMLLINT_COMPATIBLE_PATH _cmake_path _result ) - execute_process( - COMMAND ${CYGPATH_EXECUTABLE} -u ${_cmake_path} - OUTPUT_VARIABLE _cygwin_path - ) - # cygpath adds a linefeed. - string(STRIP "${_cygwin_path}" _cygwin_path) - - set( ${_result} ${_cygwin_path} ) - ENDMACRO() - - TO_XMLLINT_COMPATIBLE_PATH( ${CMAKE_CURRENT_SOURCE_DIR} _xmllint_current_source_dir ) - TO_XMLLINT_COMPATIBLE_PATH( ${CMAKE_CURRENT_BINARY_DIR} _xmllint_current_binary_dir ) - - set ( _xmllint_path "${_xmllint_current_source_dir}:${_xmllint_current_binary_dir}:${_xmllint_current_binary_dir}/wsluarm_src") -else() - set ( _xmllint_path "${CMAKE_CURRENT_SOURCE_DIR}:${CMAKE_CURRENT_BINARY_DIR}:${CMAKE_CURRENT_BINARY_DIR}/wsluarm_src") -endif() - -# Validate XML -# XXX Unused? -MACRO(VALIDATE_XML _validated _sources) - # FIXME: How do I extract the first element of a variable containing a - # list of values? Isn't there a "cleaner" solution? - # Oh, and I have no idea why I can't directly use _source instead of - # having to introduce _tmpsource. - FOREACH(_tmpsource ${${_sources}}) - set(_source ${_tmpsource}) - BREAK() - ENDFOREACH() - ADD_CUSTOM_COMMAND( - OUTPUT - ${_validated} - COMMAND ${XMLLINT_EXECUTABLE} - --path "${_xmllint_path}" - --valid - --noout - ${_source} - COMMAND ${CMAKE_COMMAND} -E touch - ${_validated} - DEPENDS - ${${_sources}} - ) -ENDMACRO(VALIDATE_XML) diff --git a/cmake/modules/FindXSLTPROC.cmake b/cmake/modules/FindXSLTPROC.cmake index 6b3b71df4a..ea1d688ee8 100644 --- a/cmake/modules/FindXSLTPROC.cmake +++ b/cmake/modules/FindXSLTPROC.cmake @@ -78,7 +78,6 @@ endif() MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources) # We depend on the docbook target to avoid parallel builds. SET(_dbk_dep ${_target_dep}_docbook) - #SET(_validated ${_dir_pfx}.validated) IF(${_mode} STREQUAL "chunked") SET(_basedir ${_dir_pfx}_html_chunked) @@ -129,7 +128,6 @@ MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources) DEPENDS generate_${_dbk_source} ${_dbk_dep} - #${_validated} ${_gfx_deps} ) IF(NOT WIN32) diff --git a/config.nmake b/config.nmake index d062488c54..c899915d5e 100644 --- a/config.nmake +++ b/config.nmake @@ -1366,9 +1366,6 @@ FOP_OPTS=-Xmx256m # the XSL processor (part of cygwin's libxslt package) XSLTPROC="xsltproc" -# the XML validator (part of cygwin's libxml2 package) -XMLLINT="xmllint" - # Asciidoc converter (part of cygwin's asciidoc package). In order to build # the release notes you must have the Cygwin asciidoc and lynx packages # installed. diff --git a/configure.ac b/configure.ac index 75b14578d6..3438dcb315 100644 --- a/configure.ac +++ b/configure.ac @@ -785,11 +785,6 @@ AC_PATH_PROG(W3M, w3m) AC_CHECK_PROG(HAVE_W3M, w3m, "yes", "no") AM_CONDITIONAL(HAVE_W3M, test x$HAVE_W3M = xyes) -# Check for xmllint -AC_PATH_PROG(XMLLINT, xmllint) -AC_CHECK_PROG(HAVE_XMLLINT, xmllint, "yes", "no") -AM_CONDITIONAL(HAVE_XMLLINT, test x$HAVE_XMLLINT = xyes) - # Check for xsltproc AC_PATH_PROG(XSLTPROC, xsltproc) AC_CHECK_PROG(HAVE_XSLTPROC, xsltproc, "yes", "no") 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 |