forked from osmocom/wireshark
296 lines
9.1 KiB
Makefile
296 lines
9.1 KiB
Makefile
#
|
|
# Make the "Wireshark User Guide" and "Wireshark Developer Guide"
|
|
# in several formats.
|
|
# See the Readme.txt file for instructions.
|
|
#
|
|
|
|
# formatting objects processor
|
|
# Additional options to fop.
|
|
# This needs to contain at least the argument '-Xmx256m'
|
|
# fop executable is found in configure.ac.
|
|
FOP_OPTS=-Xmx256m
|
|
|
|
# Asciidoc converter
|
|
A2X_HTML_OPTS="--stylesheet=ws.css"
|
|
A2X_TEXT_OPTS=
|
|
|
|
#if HAVE_LYNX
|
|
A2X_TEXT_OPTS+="--lynx"
|
|
#endif
|
|
|
|
# html to text converter for text version of release notes, e.g. elinks.
|
|
# This could also be "lynx", or "true" if neither elinks nor lynx is installed
|
|
# (See Bug # 1446 for note re 'force-html' below)
|
|
# Sorry about the indenting, but that's what automake requires...
|
|
if HAVE_ELINKS
|
|
HTML2TXT=$(ELINKS) -dump -dump-width 72
|
|
## links: -dump requires 'url' argument (as opposed to elinks & lynx)
|
|
## (Rather than fixing things we'll just disable the use of links).
|
|
##else
|
|
##if HAVE_LINKS
|
|
##HTML2TXT=$(LINKS) -dump -width 72
|
|
else
|
|
if HAVE_LYNX
|
|
HTML2TXT=$(LYNX) -dump -width=72 -nolist -stdin -force-html
|
|
else
|
|
HTML2TXT="true"
|
|
endif
|
|
##endif
|
|
endif
|
|
|
|
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
|
|
|
|
include Makefile.common
|
|
|
|
# Automatically generate .pdf files from .fo files
|
|
# Suse needs FOP_OPTS, Debian needs JAVA_OPTS
|
|
.fo.pdf:
|
|
if HAVE_FOP
|
|
FOP_OPTS=$(FOP_OPTS) JAVA_OPTS=$(FOP_OPTS) $(FOP) $< $@
|
|
else
|
|
@echo
|
|
@echo "Error: FOP is needed to create PDFs!"
|
|
@false
|
|
endif
|
|
|
|
# Convert an AsciiDoc document to a DocBook chapter
|
|
# Used for chapter-by-chapter conversion from DocBook to AsciiDoc.
|
|
# Can be removed after the User's Guide is converted.
|
|
# .asciidoc -> whole book (.dbk) -> chapter (.xml)
|
|
wsug_src/%.xml : wsug_src/%.asciidoc
|
|
$(A2X) --verbose \
|
|
--asciidoc-opts="--conf-file=$(srcdir)/asciidoc.conf" \
|
|
--no-xmllint \
|
|
--format=docbook --doctype=book \
|
|
$<
|
|
mv wsug_src/$*.xml wsug_src/$*.dbk
|
|
xmllint --xpath '//chapter | //preface' wsug_src/$*.dbk > $@
|
|
|
|
if HAVE_XSLTPROC
|
|
ALL_TARGETS=git_version_check wsug wsdg release_notes
|
|
else
|
|
# if we don't have XSLTPROC, there's nothing to do...
|
|
ALL_TARGETS=git_version_check
|
|
endif
|
|
|
|
all: $(ALL_TARGETS)
|
|
|
|
#
|
|
# on every build, record the working copy revision string
|
|
#
|
|
# FORCE is the portable version of .PHONY
|
|
FORCE:
|
|
|
|
git_version_check: FORCE
|
|
cat $(srcdir)/check_git_version.sh | tr -d '\015' | /bin/bash
|
|
|
|
git_version.xml: git_version_check
|
|
|
|
# Wireshark User Guide
|
|
if HAVE_FOP
|
|
WSUG_TARGETS=wsug.validated wsug_html_chunked wsug_html user-guide-a4.pdf user-guide-us.pdf
|
|
else
|
|
WSUG_TARGETS=wsug.validated wsug_html_chunked wsug_html
|
|
endif
|
|
|
|
wsug: $(WSUG_TARGETS)
|
|
|
|
# validate the content
|
|
wsug.validated: $(WSUG_SOURCE) wsluarm
|
|
if HAVE_XMLLINT
|
|
@ echo --- WSUG - VALIDATING XML ---
|
|
$(XMLLINT) --path .:wsluarm_src:$(srcdir) --valid --noout $<
|
|
touch $@
|
|
else
|
|
@ echo --- WSUG - SKIP VALIDATION ---
|
|
endif
|
|
|
|
# create html single page file
|
|
wsug_html: wsug_html/index.html
|
|
|
|
wsug_html/index.html: $(WSUG_SOURCE) wsluarm
|
|
@ echo --- WSUG - HTML SINGLE PAGE ---
|
|
mkdir -p wsug_html/wsug_graphics/toolbar
|
|
cp $(srcdir)/wsug_graphics/*.* wsug_html/wsug_graphics
|
|
cp $(srcdir)/common_graphics/*.* wsug_html/wsug_graphics
|
|
cp $(srcdir)/wsug_graphics/toolbar/* wsug_html/wsug_graphics/toolbar
|
|
cp $(srcdir)/ws.css wsug_html
|
|
$(XSLTPROC) --stringparam base.dir wsug_html/ $(COMMON_XSLTPROC_ARGS) \
|
|
--path .:wsluarm_src $(SINGLE_XSLTPROC_ARGS) $< > $@
|
|
-chmod -R og+rX wsug_html
|
|
|
|
# create html chunked page files
|
|
wsug_html_chunked: wsug_html_chunked/index.html
|
|
|
|
wsug_html_chunked/index.html: $(WSUG_SOURCE) wsluarm
|
|
@ echo --- WSUG - HTML CHUNKED ---
|
|
mkdir -p wsug_html_chunked/wsug_graphics/toolbar
|
|
cp $(srcdir)/wsug_graphics/*.* wsug_html_chunked/wsug_graphics
|
|
cp $(srcdir)/common_graphics/*.* wsug_html_chunked/wsug_graphics
|
|
cp $(srcdir)/wsug_graphics/toolbar/* wsug_html_chunked/wsug_graphics/toolbar
|
|
cp $(srcdir)/ws.css wsug_html_chunked
|
|
$(XSLTPROC) --stringparam base.dir wsug_html_chunked/ $(COMMON_XSLTPROC_ARGS) \
|
|
--path .:wsluarm_src \
|
|
$(CHUNKED_XSLTPROC_ARGS) $<
|
|
-chmod -R og+rX wsug_html_chunked
|
|
|
|
# create pdf file (through XSL-FO), portrait pages on US letter paper
|
|
# you will get lot's of errors, but that's ok
|
|
user-guide-us.fo: $(WSUG_SOURCE) custom_layer_pdf.xsl wsluarm
|
|
@ echo --- WSUG - PDF US PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type letter \
|
|
--path .:wsluarm_src:$(srcdir) \
|
|
--nonet custom_layer_pdf.xsl $< > $@
|
|
|
|
# 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 wsluarm
|
|
@ echo --- WSUG - PDF A4 PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type A4 \
|
|
--path .:wsluarm_src:$(srcdir) \
|
|
--nonet custom_layer_pdf.xsl $< > $@
|
|
|
|
wsluarm: make-wsluarm.pl $(WSLUA_MODULES)
|
|
mkdir -p wsluarm_src
|
|
$(PERL) $(srcdir)/make-wsluarm.pl $(WSLUA_MODULES)
|
|
touch wsluarm
|
|
|
|
|
|
# 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
|
|
else
|
|
WSDG_TARGETS=wsdg.validated wsdg_html_chunked wsdg_html
|
|
endif
|
|
else
|
|
WSDG_TARGETS=
|
|
endif
|
|
|
|
wsdg: $(WSDG_TARGETS)
|
|
|
|
developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES)
|
|
$(A2X) --verbose \
|
|
--attribute=docinfo \
|
|
--asciidoc-opts="--conf-file=$(srcdir)/asciidoc.conf" \
|
|
--no-xmllint \
|
|
--format=docbook \
|
|
$<
|
|
|
|
# validate the content
|
|
wsdg.validated: $(WSDG_SOURCE)
|
|
if HAVE_XMLLINT
|
|
@ echo --- WSDG - VALIDATING XML ---
|
|
$(XMLLINT) --path .:$(srcdir) --valid --noout $<
|
|
touch $@
|
|
else
|
|
@ echo --- WSDG - SKIP VALIDATION ---
|
|
endif
|
|
|
|
# create html single page file
|
|
wsdg_html: wsdg_html/index.html
|
|
|
|
wsdg_html/index.html: $(WSDG_SOURCE)
|
|
@ echo --- WSDG - HTML SINGLE PAGE ---
|
|
mkdir -p wsdg_html/wsdg_graphics/toolbar
|
|
cp $(srcdir)/wsdg_graphics/*.* wsdg_html/wsdg_graphics
|
|
cp $(srcdir)/common_graphics/*.* wsdg_html/wsdg_graphics
|
|
cp $(srcdir)/wsdg_graphics/toolbar/* wsdg_html/wsdg_graphics/toolbar/
|
|
cp $(srcdir)/ws.css wsdg_html
|
|
$(XSLTPROC) --stringparam base.dir wsdg_html/ $(COMMON_XSLTPROC_ARGS) \
|
|
$(SINGLE_XSLTPROC_ARGS) $< > $@
|
|
-chmod -R og+rX wsdg_html
|
|
|
|
# create html chunked page files
|
|
wsdg_html_chunked: wsdg_html_chunked/index.html
|
|
|
|
wsdg_html_chunked/index.html: $(WSDG_SOURCE)
|
|
@ echo --- WSDG - HTML CHUNKED ---
|
|
mkdir -p wsdg_html_chunked/wsdg_graphics/toolbar
|
|
cp $(srcdir)/wsdg_graphics/*.* wsdg_html_chunked/wsdg_graphics
|
|
cp $(srcdir)/common_graphics/*.* wsdg_html_chunked/wsdg_graphics
|
|
cp $(srcdir)/wsdg_graphics/toolbar/* wsdg_html_chunked/wsdg_graphics/toolbar/
|
|
cp $(srcdir)/ws.css wsdg_html_chunked
|
|
$(XSLTPROC) --stringparam base.dir wsdg_html_chunked/ $(COMMON_XSLTPROC_ARGS) \
|
|
$(CHUNKED_XSLTPROC_ARGS) $<
|
|
-chmod -R og+rX wsdg_html_chunked
|
|
|
|
# create pdf file (through XSL-FO), portrait pages on US letter paper
|
|
# you will get lot's of errors, but that's ok
|
|
developer-guide-us.fo: $(WSDG_SOURCE) custom_layer_pdf.xsl
|
|
@ echo --- WSDG - PDF US PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type letter \
|
|
--path .:$(srcdir) \
|
|
--nonet custom_layer_pdf.xsl $< > $@
|
|
|
|
# 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
|
|
@ echo --- WSDG - PDF A4 PAPER ---
|
|
$(XSLTPROC) --stringparam paper.type A4 \
|
|
--path .:$(srcdir) \
|
|
--nonet custom_layer_pdf.xsl $< > $@
|
|
|
|
|
|
if HAVE_FOP
|
|
RELEASE_NOTES_TARGETS=release-notes.html release-notes.txt release-notes-a4.pdf release-notes-us.pdf
|
|
else
|
|
RELEASE_NOTES_TARGETS=release-notes.html release-notes.txt
|
|
endif
|
|
|
|
release_notes: $(RELEASE_NOTES_TARGETS)
|
|
|
|
# create html single page file
|
|
release-notes.html: $(RELEASE_NOTES_SOURCE)
|
|
@ echo --- RELEASE NOTES - HTML ---
|
|
$(A2X) --format=xhtml $(A2X_HTML_OPTS) $(srcdir)/release-notes.asciidoc
|
|
|
|
# create txt single page file (through HTML)
|
|
release-notes.txt: $(RELEASE_NOTES_SOURCE)
|
|
@ echo --- RELEASE NOTES - TXT ---
|
|
$(A2X) --format=text $(A2X_TEXT_OPTS) \
|
|
--xsltproc-opts "--stringparam generate.toc \"article nop\"" \
|
|
$(srcdir)/release-notes.asciidoc
|
|
mv $(srcdir)/release-notes.text $@
|
|
|
|
news: release-notes.txt
|
|
cp release-notes.txt ../NEWS
|
|
-cp release-notes.txt $(top_srcdir)/NEWS
|
|
|
|
# Apparently we can only run one instance of a2x at a time.
|
|
.NOTPARALLEL: release-notes-us.pdf release-notes-a4.pdf
|
|
# 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 ---
|
|
$(A2X) --format=pdf $(A2X_HTML_OPTS) --fop \
|
|
--xsltproc-opts "--stringparam paper.type letter --nonet" \
|
|
--xsl-file=$(srcdir)/custom_layer_pdf.xsl \
|
|
$(srcdir)/release-notes.asciidoc
|
|
mv $(srcdir)/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 ---
|
|
$(A2X) --format=pdf $(A2X_HTML_OPTS) --fop \
|
|
--xsltproc-opts "--stringparam paper.type A4 --nonet" \
|
|
--xsl-file=$(srcdir)/custom_layer_pdf.xsl \
|
|
$(srcdir)/release-notes.asciidoc
|
|
mv $(srcdir)/release-notes.pdf $@
|
|
|
|
clean-local:
|
|
-rm -rf $(CLEANDIRS)
|
|
|
|
EXTRA_DIST = \
|
|
$(WSUG_DIST) \
|
|
$(WSDG_DIST) \
|
|
$(RELEASE_NOTES_SOURCE) \
|
|
check_git_version.sh \
|
|
dfilter2xml.pl \
|
|
make-wsluarm.pl \
|
|
README.txt \
|
|
Makefile.nmake \
|
|
CMakeLists.txt
|
|
|
|
MAINTAINERCLEANFILES = \
|
|
Makefile.in
|