diff options
author | Pascal Quantin <pascal.quantin@gmail.com> | 2016-06-08 15:57:00 +0200 |
---|---|---|
committer | Michael Mann <mmann78@netscape.net> | 2016-06-15 19:21:57 +0000 |
commit | 6baa1b544c84a766d9f9d356e9940eccaf0a128f (patch) | |
tree | fc5431419180335703edcbf01e6b260d2c0dcbfd /docbook | |
parent | 88bd50c592b0d24a12dd178ae2858444400a012f (diff) |
Remove Nmake build system
Change-Id: I3bd474f3cda9667dec66426b5729449953df3e61
Reviewed-on: https://code.wireshark.org/review/15777
Petri-Dish: Pascal Quantin <pascal.quantin@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
Reviewed-by: Balint Reczey <balint@balintreczey.hu>
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/Makefile.am | 1 | ||||
-rw-r--r-- | docbook/Makefile.nmake | 280 | ||||
-rw-r--r-- | docbook/README.txt | 23 |
3 files changed, 4 insertions, 300 deletions
diff --git a/docbook/Makefile.am b/docbook/Makefile.am index ecee49acf7..8a72d69e06 100644 --- a/docbook/Makefile.am +++ b/docbook/Makefile.am @@ -213,7 +213,6 @@ EXTRA_DIST = \ dfilter2xml.pl \ make-wsluarm.pl \ README.txt \ - Makefile.nmake \ CMakeLists.txt MAINTAINERCLEANFILES = \ diff --git a/docbook/Makefile.nmake b/docbook/Makefile.nmake deleted file mode 100644 index 23fa4c748d..0000000000 --- a/docbook/Makefile.nmake +++ /dev/null @@ -1,280 +0,0 @@ -# -# Make the "Wireshark User Guide" and "Wireshark Developer Guide" -# in several formats. -# See the Readme.txt file for instructions. -# -## Use: $(MAKE) /$(MAKEFLAGS) -f makefile.nmake [target ...] -# - -############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################ - -TOOLS_DIR=..\tools -include ..\config.nmake -top_srcdir=.. -srcdir=. -include Makefile.common - -WSUG_SOURCE = $(WSUG_SOURCE) Makefile.nmake -WSDG_SOURCE = $(WSDG_SOURCE) Makefile.nmake -RELEASE_NOTES_SOURCE = $(RELEASE_NOTES_SOURCE) Makefile.nmake - -# Asciidoc converter -A2X_HTML_OPTS="--stylesheet=ws.css" -A2X_TEXT_OPTS= - -!ifdef LYNX -A2X_TEXT_OPTS=$(A2X_TEXT_OPTS) --lynx -!endif - -# Automatically generate .pdf files from .fo files -.fo.pdf: - $(FOP) $< $@ - -.SUFFIXES: .fo .pdf - -# -- (Public) targets ------------------------------------------------------- - -# Make all (default) -all: wsug_x wsdg_x release_notes_x - -# Make only the WSUG -wsug: wsug_x - -# Make only the WSDG -wsdg: wsdg_x - -# Make only the release notes -release_notes: release_notes_x - -# Clean all -clean: - rm -rf $(CLEANFILES) $(CLEANDIRS) - -distclean: clean - -maintainer-clean: distclean - -# -- User Guide ------------------------------------------------------------------------ - -wsug_x: wsug_html_chunked wsug_html user-guide-a4.pdf user-guide-us.pdf user-guide.chm - -user-guide.xml: user-guide.asciidoc $(WSUG_FILES) user-guide-docinfo.xml - @ echo --- WSUG - XML --- - $(SH) << - PATH=/usr/bin - PYTHONHOME=/ - $(A2X) --verbose \ - --attribute=docinfo \ - --asciidoc-opts="--conf-file=asciidoc.conf --conf-file=asciidoctor-asciidoc.conf" \ - --no-xmllint \ - --format=docbook \ - user-guide.asciidoc -<< - -# create html single page file -wsug_html: wsug_html\index.html - -wsug_html\index.html: $(WSUG_SOURCE) - @ echo --- WSUG - HTML SINGLE PAGE --- - if not exist wsug_html\wsug_graphics\toolbar md wsug_html\wsug_graphics\toolbar - cp wsug_graphics/*.* wsug_html/wsug_graphics - cp common_graphics/*.* wsug_html/wsug_graphics - cp wsug_graphics/toolbar/* wsug_html/wsug_graphics/toolbar - cp ws.css wsug_html - $(XSLTPROC) --stringparam base.dir wsug_html/ $(COMMON_XSLTPROC_ARGS) \ - $(WSUG_XSLTPROC_ARGS) $(SINGLE_XSLTPROC_ARGS) user-guide.xml > $@ - -# create html chunked page files -wsug_html_chunked: wsug_html_chunked\index.html - -wsug_html_chunked\index.html: $(WSUG_SOURCE) - @ echo --- WSUG - HTML CHUNKED --- - if not exist wsug_html_chunked\wsug_graphics\toolbar md wsug_html_chunked\wsug_graphics\toolbar - cp wsug_graphics/*.* wsug_html_chunked/wsug_graphics - cp common_graphics/*.* wsug_html_chunked/wsug_graphics - cp wsug_graphics/toolbar/* wsug_html_chunked/wsug_graphics/toolbar - cp ws.css wsug_html_chunked - $(XSLTPROC) --stringparam base.dir wsug_html_chunked/ $(COMMON_XSLTPROC_ARGS) \ - $(WSUG_XSLTPROC_ARGS) $(CHUNKED_XSLTPROC_ARGS) user-guide.xml - -# create pdf file (through XSL-FO), portrait pages on US letter paper (the default) -# you will get lot's of errors, but that's ok -user-guide-us.fo: $(WSUG_SOURCE) custom_layer_pdf.xsl -!ifdef FOP - @ echo --- WSUG - PDF US PAPER --- - $(XSLTPROC) --stringparam paper.type letter \ - $(COMMON_XSLTPROC_ARGS) $(WSUG_PDF_XSLTPROC_ARGS) \ - --nonet custom_layer_pdf.xsl user-guide.xml > $@ -!endif - -# create pdf file (through XSL-FO), portrait pages on A4 paper -# you will get lot's of errors, but that's ok -user-guide-a4.fo: $(WSUG_SOURCE) custom_layer_pdf.xsl -!ifdef FOP - @ echo --- WSUG - PDF A4 PAPER --- - $(XSLTPROC) --stringparam paper.type A4 \ - $(COMMON_XSLTPROC_ARGS) $(WSUG_PDF_XSLTPROC_ARGS) \ - --nonet custom_layer_pdf.xsl user-guide.xml > $@ -!endif - -# create MS html help file (through html chunked pages) -user-guide.chm: $(WSUG_SOURCE) -!ifdef HHC_EXE - @ echo --- WSUG - MICROSOFT HTML HELP --- - if not exist wsug_chm\wsug_graphics\toolbar md wsug_chm\wsug_graphics\toolbar - -cp wsug_graphics/*.* wsug_chm/wsug_graphics - -cp common_graphics/*.* wsug_chm/wsug_graphics - -cp wsug_graphics/toolbar/* wsug_chm/wsug_graphics/toolbar - $(XSLTPROC) --stringparam base.dir wsug_chm/ $(COMMON_XSLTPROC_ARGS) \ - $(WSUG_XSLTPROC_ARGS) $(HTMLHELP_XSLTPROC_ARGS) user-guide.xml - -$(HHC_EXE) htmlhelp.hhp - -mv htmlhelp.chm $@ - -rm -r htmlhelp.hhp - -rm -r toc.hhc -!endif - -wsluarm: make-wsluarm.pl $(WSLUA_MODULES) - if not exist wsluarm_src md wsluarm_src - $(PERL) make-wsluarm.pl $(WSLUA_MODULES) - touch wsluarm - -# -- Developer's Guide ------------------------------------------------------------------------ - -wsdg_x: wsdg_html_chunked wsdg_html developer-guide-a4.pdf developer-guide-us.pdf developer-guide.chm - -developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES) wsluarm developer-guide-docinfo.xml - @ echo --- WSDG - XML --- - $(SH) << - PATH=/usr/bin - PYTHONHOME=/ - $(A2X) --verbose \ - --attribute=docinfo \ - --asciidoc-opts="--conf-file=asciidoc.conf --conf-file=asciidoctor-asciidoc.conf" \ - --no-xmllint \ - --format=docbook \ - developer-guide.asciidoc -<< - -# create html single page file -wsdg_html: wsdg_html\index.html - -wsdg_html\index.html: $(WSDG_SOURCE) - @ echo --- WSDG - HTML SINGLE PAGE --- - if not exist wsdg_html\wsdg_graphics md wsdg_html\wsdg_graphics - if not exist wsdg_html\wsdg_graphics\toolbar md wsdg_html\wsdg_graphics\toolbar - cp wsdg_graphics/*.* wsdg_html/wsdg_graphics - cp common_graphics/*.* wsdg_html/wsdg_graphics - cp wsdg_graphics/toolbar/* wsdg_html/wsdg_graphics/toolbar - cp ws.css wsdg_html - $(XSLTPROC) --stringparam base.dir wsdg_html/ $(COMMON_XSLTPROC_ARGS) \ - $(WSDG_XSLTPROC_ARGS) $(SINGLE_XSLTPROC_ARGS) developer-guide.xml > $@ - -# create html chunked page files -wsdg_html_chunked: wsdg_html_chunked\index.html - -wsdg_html_chunked\index.html: $(WSDG_SOURCE) - @ echo --- WSDG - HTML CHUNKED --- - if not exist wsdg_html_chunked\wsdg_graphics md wsdg_html_chunked\wsdg_graphics - if not exist wsdg_html_chunked\wsdg_graphics\toolbar md wsdg_html_chunked\wsdg_graphics\toolbar - cp wsdg_graphics/*.* wsdg_html_chunked/wsdg_graphics - cp common_graphics/*.* wsdg_html_chunked/wsdg_graphics - cp wsdg_graphics/toolbar/* wsdg_html_chunked/wsdg_graphics/toolbar - cp ws.css wsdg_html_chunked - $(XSLTPROC) --stringparam base.dir wsdg_html_chunked/ $(COMMON_XSLTPROC_ARGS) \ - $(WSDG_XSLTPROC_ARGS) $(CHUNKED_XSLTPROC_ARGS) developer-guide.xml - -# create pdf file (through XSL-FO), portrait pages on US letter paper (the default) -# you will get lot's of errors, but that's ok -developer-guide-us.fo: $(WSDG_SOURCE) custom_layer_pdf.xsl -!ifdef FOP - @ echo --- WSDG - PDF US PAPER --- - $(XSLTPROC) --stringparam paper.type letter \ - $(COMMON_XSLTPROC_ARGS) $(WSDG_PDF_XSLTPROC_ARGS) \ - --nonet custom_layer_pdf.xsl developer-guide.xml > $@ -!endif - -# create pdf file (through XSL-FO), portrait pages on A4 paper -# you will get lot's of errors, but that's ok -developer-guide-a4.fo: $(WSDG_SOURCE) custom_layer_pdf.xsl -!ifdef FOP - @ echo --- WSDG - PDF A4 PAPER --- - $(XSLTPROC) --stringparam paper.type A4 \ - $(COMMON_XSLTPROC_ARGS) $(WSDG_PDF_XSLTPROC_ARGS) \ - --nonet custom_layer_pdf.xsl developer-guide.xml > $@ -!endif - -# create MS html help file (through html chunked pages) -developer-guide.chm: $(WSDG_SOURCE) -!ifdef HHC_EXE - @ echo --- WSDG - MICROSOFT HTML HELP --- - if not exist wsdg_chm\wsdg_graphics md wsdg_chm\wsdg_graphics - if not exist wsdg_chm\wsdg_graphics\toolbar md wsdg_chm\wsdg_graphics\toolbar - -cp wsdg_graphics/*.* wsdg_chm/wsdg_graphics - -cp common_graphics/*.* wsdg_chm/wsdg_graphics - -cp wsdg_graphics/toolbar/* wsdg_chm/wsdg_graphics/toolbar - $(XSLTPROC) --stringparam base.dir wsdg_chm/ $(COMMON_XSLTPROC_ARGS) \ - $(WSDG_XSLTPROC_ARGS) $(HTMLHELP_XSLTPROC_ARGS) developer-guide.xml - -$(HHC_EXE) htmlhelp.hhp - -mv htmlhelp.chm $@ - -rm -r htmlhelp.hhp - -rm -r toc.hhc -!endif - -# -- Release Notes ------------------------------------------------------------------------ - -release_notes_x: release-notes.html release-notes.txt - -release_notes_pdf: release-notes-a4.pdf release-notes-us.pdf - -# create html single page file -release-notes.html: $(RELEASE_NOTES_SOURCE) - @ echo --- RELEASE NOTES - HTML --- - $(SH) << - PATH=/usr/bin - PYTHONHOME=/ - $(A2X) -v --format=xhtml $(A2X_HTML_OPTS) release-notes.asciidoc -<< - -# create txt single page file (through HTML) -release-notes.txt: $(RELEASE_NOTES_SOURCE) - @ echo --- RELEASE NOTES - TXT --- - $(SH) << - PATH=/usr/bin - PYTHONHOME=/ - TZ=UTC - $(A2X) -v --format=text $(A2X_TEXT_OPTS) \ - --xsltproc-opts "--stringparam generate.toc \"article nop\"" \ - release-notes.asciidoc -<< - mv release-notes.text $@ - -news: release-notes.txt - copy release-notes.txt ..\NEWS - -# create pdf file, portrait pages on US letter paper -release-notes-us.pdf: $(RELEASE_NOTES_SOURCE) custom_layer_pdf.xsl - @ echo --- RELEASE NOTES - PDF US LETTER PAPER --- - $(SH) << - PATH=/usr/bin - PYTHONHOME=/ - $(A2X) --format=pdf $(A2X_HTML_OPTS) \ - --xsltproc-opts "--stringparam paper.type letter --nonet" \ - --xsl-file=custom_layer_pdf.xsl \ - release-notes.asciidoc -<< - mv release-notes.pdf $@ - -# create pdf file, portrait pages on A4 paper -release-notes-a4.pdf: $(RELEASE_NOTES_SOURCE) custom_layer_pdf.xsl - @ echo --- RELEASE NOTES - PDF A4 PAPER --- - $(SH) << - PATH=/usr/bin - PYTHONHOME=/ - $(A2X) --format=pdf $(A2X_HTML_OPTS) \ - --xsltproc-opts "--stringparam paper.type A4 --nonet" \ - --xsl-file=custom_layer_pdf.xsl \ - release-notes.asciidoc -<< - mv release-notes.pdf $@ - -_FORCE_: ## Assumption: no file named _FORCE_ exists in the current directory diff --git a/docbook/README.txt b/docbook/README.txt index 88fec4b47d..923efb5e35 100644 --- a/docbook/README.txt +++ b/docbook/README.txt @@ -6,7 +6,7 @@ This directory contains the source files needed to build the: - Lua Reference -To build everything, just do 'make' (for Win32: 'nmake -f Makefile.nmake') +To build everything, just do 'make' (for Win32: see README.cmake) but see the requirements below. The guides are written in Docbook/XML (formerly Docbook/SGML). The release @@ -18,18 +18,6 @@ stylesheets, which provides a flexible way for these conversions. By default the Makefile generates HTML in single page and multiple (chunked) formats and two PDF's. -Win32 only: The optional output format CHM has to be enabled by setting -HHC_EXE in ..\config.nmake. Microsoft has dropped support for HTML Help - - -Settings: ---------- - -Win32 only: ..\config.nmake ---------------------------- -Settings moved to: ..\config.nmake. - - Requirements: ------------- @@ -59,8 +47,7 @@ http://xml.apache.org/fop/ FOP is a Java program, so you need to have a Java environment installed. 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. +this location by setting the FOP environment variable. FOP might return an OutOfMemoryException. You can limit its memory usage by adding " -Xmx256m" to the FOP_OPTS environment variable. The Windows @@ -126,7 +113,6 @@ http://www.microsoft.com/en-us/download/details.aspx?id=21138 Packages for Win32 ------------------ -See ..\config.nmake for Win32 settings. Installing the asciidoc package will pull in almost all the other required Cygwin packages. You may need to run "build-docbook-catalog" from a Cygwin bash prompt in order to register your catalog properly. @@ -139,7 +125,7 @@ docbookx.dtd: Text/docbook-xml42 M a later version may be r 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 +fop: - O URL: http://xml.apache.org/fop/ - install it into docbok\fop-1.x or wireshark_lib_dir\fop-1.x 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" @@ -207,7 +193,7 @@ fop: fop O See above -Makefile / Makefile.nmake: +Makefile: -------------------------- There are several ways and tools to do these conversion, following is a short description of the way the makefile targets are doing things and which output @@ -249,7 +235,6 @@ Using the prefix wsdg_ instead of wsug_ will build the same targets but for the Wireshark Developer's Guide. The makefile is written to be run with make on UNIX/Linux platforms. -Win32 platforms have to use nmake -f Makefile.nmake Notes to authors |