osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity
wireshark/docbook/Makefile.am

504 lines
16 KiB
Makefile
Raw Normal View History

Svn stuff: - Add eol-style native to all text files - Add Id attributes Add $Id: $ to all text files Makefile: - add several files and directories to make clean - Add comments for values on Suse 9.1 catalog.xml: - Add comments for values on Suse 9.1 svn path=/trunk/; revision=11618
2004-08-06 21:06:27 +00:00
#
edg -> wsdg -This line, and those below, will be ignored-- D docbook/edg_graphics M docbook/developer-guide.xml M docbook/Makefile.auto.am A docbook/wsdg_graphics D docbook/edg_src M docbook/README.txt A docbook/wsdg_src D docbook/wsdg_src/EDG_meta_info.xml A docbook/wsdg_src/WSDG_userinterface.xml D docbook/wsdg_src/EDG_preface.xml D docbook/wsdg_src/EDG_chapter_userinterface.xml D docbook/wsdg_src/EDG_chapter_tools.xml A docbook/wsdg_src/WSDG_meta_info.xml D docbook/wsdg_src/EDG_chapter_env_intro.xml D docbook/wsdg_src/EDG_chapter_capture.xml A docbook/wsdg_src/WSDG_preface.xml A docbook/wsdg_src/WSDG_works.xml D docbook/wsdg_src/EDG_chapter_dissection.xml A docbook/wsdg_src/WSDG_chapter_tools.xml D docbook/wsdg_src/EDG_chapter_works.xml A docbook/wsdg_src/WSDG_chapter_env_intro.xml A docbook/wsdg_src/WSDG_chapter_capture.xml A docbook/wsdg_src/WSDG_chapter_dissection.xml D docbook/wsdg_src/EDG_chapter_build_intro.xml D docbook/wsdg_src/EDG_chapter_libraries.xml A docbook/wsdg_src/WSDG_chapter_build_intro.xml A docbook/wsdg_src/WSDG_chapter_libraries.xml D docbook/wsdg_src/EDG_chapter_sources.xml A docbook/wsdg_src/WSDG_chapter_sources.xml M docbook/Makefile svn path=/trunk/; revision=18368
2006-06-06 23:08:58 +00:00
# Make the "Wireshark User Guide" and "Wireshark Developer Guide"
# in several formats.
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
# See the README.adoc file for instructions.
Svn stuff: - Add eol-style native to all text files - Add Id attributes Add $Id: $ to all text files Makefile: - add several files and directories to make clean - Add comments for values on Suse 9.1 catalog.xml: - Add comments for values on Suse 9.1 svn path=/trunk/; revision=11618
2004-08-06 21:06:27 +00:00
#
Use -N for commits on directories or back out all local changes afterwards svn path=/trunk/; revision=11807
2004-08-22 09:16:01 +00:00
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
Ignore developer-guide.pdf svn path=/trunk/; revision=11806
2004-08-22 09:10:12 +00:00
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
WSUG_FILES = \
wsug_src/WSUG_app_files.asciidoc \
wsug_src/WSUG_app_howitworks.asciidoc \
wsug_src/WSUG_app_messages.asciidoc \
wsug_src/WSUG_app_protocols.asciidoc \
wsug_src/WSUG_app_tools.asciidoc \
wsug_src/WSUG_chapter_advanced.asciidoc \
wsug_src/WSUG_chapter_build_install.asciidoc \
wsug_src/WSUG_chapter_capture.asciidoc \
wsug_src/WSUG_chapter_customize.asciidoc \
wsug_src/WSUG_chapter_introduction.asciidoc \
wsug_src/WSUG_chapter_io.asciidoc \
wsug_src/WSUG_chapter_statistics.asciidoc \
wsug_src/WSUG_chapter_telephony.asciidoc \
wsug_src/WSUG_chapter_troubleshoot.asciidoc \
wsug_src/WSUG_chapter_use.asciidoc \
wsug_src/WSUG_chapter_work.asciidoc \
wsug_src/WSUG_preface.asciidoc \
ws.css
Docbook: Automatically generate the tools help output. Add a CMake target that dumps the help output for our command line tools to individual files. Include those files in the tools appendix instead of pasting them in manually. Fixup the output of some tools so that they pass the pre-commit checks. Change-Id: I925f24818422a190927a96531c21f4d16d3fe5b5 Reviewed-on: https://code.wireshark.org/review/23737 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-09-25 21:06:37 +00:00
WSUG_TOOLS_HELP_FILES = \
Add backslashes to definition of WSUG_TOOLS_HELP_FILES in docbook/Makefile.am Bug: 14152 Change-Id: If1d89afd5dbf62adae4cd84e3fc44bd37a8a2176 Reviewed-on: https://code.wireshark.org/review/24221 Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-11-04 01:11:25 +00:00
wsug_src/capinfos-h.txt \
wsug_src/dumpcap-h.txt \
wsug_src/editcap-F.txt \
wsug_src/editcap-T.txt \
wsug_src/editcap-h.txt \
wsug_src/mergecap-h.txt \
wsug_src/rawshark-h.txt \
wsug_src/reordercap-h.txt \
wsug_src/text2pcap-h.txt \
Docbook: Automatically generate the tools help output. Add a CMake target that dumps the help output for our command line tools to individual files. Include those files in the tools appendix instead of pasting them in manually. Fixup the output of some tools so that they pass the pre-commit checks. Change-Id: I925f24818422a190927a96531c21f4d16d3fe5b5 Reviewed-on: https://code.wireshark.org/review/23737 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-09-25 21:06:37 +00:00
wsug_src/tshark-h.txt
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
WSUG_GENERATED_SOURCE = \
user-guide.xml
WSUG_GRAPHICS = \
wsug_graphics/captureOptions.png \
wsug_graphics/related-ack.png \
wsug_graphics/related-dup-ack.png \
wsug_graphics/related-last.png \
wsug_graphics/related-request.png \
wsug_graphics/related-segment.png \
wsug_graphics/related-current.png \
wsug_graphics/related-first.png \
wsug_graphics/related-other.png \
wsug_graphics/related-response.png \
wsug_graphics/ws-analyze-menu.png \
wsug_graphics/ws-bytes-pane-tabs.png \
wsug_graphics/ws-bytes-pane.png \
wsug_graphics/ws-capture-info.png \
wsug_graphics/ws-capture-interfaces.png \
wsug_graphics/ws-capture-interface-details.png \
wsug_graphics/ws-capture-interfaces-win32.png \
wsug_graphics/ws-capture-menu.png \
wsug_graphics/ws-capture-options.png \
wsug_graphics/ws-capture-options-compile-selected-bpfs.png \
WSDG: Layout and content updates. Adjust the column widths of some tables to that they render more cleanly and without FOP warnings. Move some table content to plain text instead of trying to shove it into table cells. Fix some other layout and formatting. Change-Id: I40e40fd7ca5c3cc594ea30c8b1ad233afd4cdca4 Reviewed-on: https://code.wireshark.org/review/17880 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-09-23 01:37:01 +00:00
wsug_graphics/ws-capture-options-output.png \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
wsug_graphics/ws-capture-options-manage-interfaces-local.png \
wsug_graphics/ws-capture-options-manage-interfaces-pipes.png \
wsug_graphics/ws-capture-options-manage-interfaces-remote-plus.png \
wsug_graphics/ws-capture-options-manage-interfaces-remote.png \
wsug_graphics/ws-capture-options-manage-interfaces.png \
wsug_graphics/ws-capture-options-remote-capture.png \
wsug_graphics/ws-capture-options-remote-interface.png \
wsug_graphics/ws-capture-options-remote-settings.png \
wsug_graphics/ws-capture-options-settings.png \
wsug_graphics/ws-capture-preferences.png \
wsug_graphics/ws-choose-color-rule.png \
wsug_graphics/ws-coloring-fields.png \
wsug_graphics/ws-coloring-rules-dialog.png \
wsug_graphics/ws-column-header-popup-menu.png \
wsug_graphics/ws-decode-as-show.png \
wsug_graphics/ws-decode-as.png \
wsug_graphics/ws-details-pane-popup-menu.png \
wsug_graphics/ws-details-pane.png \
wsug_graphics/ws-display-filter-tcp.png \
wsug_graphics/ws-edit-menu.png \
wsug_graphics/ws-enabled-protocols.png \
wsug_graphics/ws-expert-colored-tree.png \
wsug_graphics/ws-expert-column.png \
wsug_graphics/ws-expert-infos.png \
wsug_graphics/ws-export-objects.png \
wsug_graphics/ws-export-pdml.png \
wsug_graphics/ws-export-plain.png \
wsug_graphics/ws-export-ps.png \
wsug_graphics/ws-export-psml.png \
wsug_graphics/ws-export-selected.png \
wsug_graphics/ws-file-import.png \
wsug_graphics/ws-file-menu.png \
wsug_graphics/ws-file-set-dialog.png \
wsug_graphics/ws-filter-add-expression.png \
wsug_graphics/ws-filter-toolbar.png \
wsug_graphics/ws-filters.png \
wsug_graphics/ws-find-packet.png \
wsug_graphics/ws-follow-stream.png \
wsug_graphics/ws-go-menu.png \
wsug_graphics/ws-goto-packet.png \
wsug_graphics/ws-gui-colors-preferences.png \
wsug_graphics/ws-gui-columns-preferences.png \
wsug_graphics/ws-gui-config-profiles.png \
wsug_graphics/ws-gui-font-preferences.png \
wsug_graphics/ws-gui-interface-options.png \
wsug_graphics/ws-gui-layout-preferences.png \
wsug_graphics/ws-gui-preferences.png \
wsug_graphics/ws-help-menu.png \
wsug_graphics/ws-internals-menu.png \
wsug_graphics/ws-list-pane.png \
wsug_graphics/ws-logo.png \
wsug_graphics/ws-main-toolbar.png \
wsug_graphics/ws-main.png \
wsug_graphics/ws-menu.png \
wsug_graphics/ws-merge-gtk24.png \
wsug_graphics/ws-merge-win32.png \
wsug_graphics/ws-nameresolution-preferences.png \
wsug_graphics/ws-open-gtk24.png \
wsug_graphics/ws-open-win32.png \
wsug_graphics/ws-packet-format.png \
wsug_graphics/ws-packet-pane-popup-menu.png \
wsug_graphics/ws-packet-range.png \
wsug_graphics/ws-packet-selected.png \
wsug_graphics/ws-packet-sep-win.png \
wsug_graphics/ws-print.png \
wsug_graphics/ws-printing-preferences.png \
wsug_graphics/ws-save-as-gtk24.png \
wsug_graphics/ws-save-as-win32.png \
wsug_graphics/ws-statistics-menu.png \
wsug_graphics/ws-stats-compare.png \
wsug_graphics/ws-stats-conversations.png \
wsug_graphics/ws-stats-endpoints.png \
wsug_graphics/ws-stats-hierarchy.png \
wsug_graphics/ws-stats-iographs.png \
wsug_graphics/ws-stats-srt-dcerpc-filter.png \
wsug_graphics/ws-stats-srt-dcerpc.png \
wsug_graphics/ws-stats-summary.png \
wsug_graphics/ws-stats-lte-mac-traffic.png \
wsug_graphics/ws-stats-lte-rlc-traffic.png \
wsug_graphics/ws-stats-wlan-traffic.png \
wsug_graphics/ws-statusbar-empty.png \
wsug_graphics/ws-statusbar-filter.png \
wsug_graphics/ws-statusbar-loaded.png \
wsug_graphics/ws-statusbar-profile.png \
wsug_graphics/ws-statusbar-selected.png \
wsug_graphics/ws-tel-rtpstream-analysis.png \
wsug_graphics/ws-telephony-menu.png \
wsug_graphics/ws-tools-menu.png \
wsug_graphics/ws-time-reference.png \
wsug_graphics/ws-view-menu.png \
wsug_graphics/toolbar/autoscroll_24.png \
wsug_graphics/toolbar/capture_filter_24.png \
wsug_graphics/toolbar/capture_interfaces_24.png \
wsug_graphics/toolbar/capture_options_24.png \
wsug_graphics/toolbar/capture_restart_24.png \
wsug_graphics/toolbar/capture_start_24.png \
wsug_graphics/toolbar/capture_stop_24.png \
wsug_graphics/toolbar/colorize_24.png \
wsug_graphics/toolbar/display_filter_24.png \
wsug_graphics/toolbar/resize_columns_24.png \
wsug_graphics/toolbar/stock_add_24.png \
wsug_graphics/toolbar/stock_apply_20.png \
wsug_graphics/toolbar/stock_bottom_24.png \
wsug_graphics/toolbar/stock_clear_24.png \
wsug_graphics/toolbar/stock_close_24.png \
wsug_graphics/toolbar/stock_colorselector_24.png \
wsug_graphics/toolbar/stock_help_24.png \
wsug_graphics/toolbar/stock_jump_to_24.png \
wsug_graphics/toolbar/stock_left_arrow_24.png \
wsug_graphics/toolbar/stock_open_24.png \
wsug_graphics/toolbar/stock_preferences_24.png \
wsug_graphics/toolbar/stock_print_24.png \
wsug_graphics/toolbar/stock_properties_24.png \
wsug_graphics/toolbar/stock_refresh_24.png \
wsug_graphics/toolbar/stock_right_arrow_24.png \
wsug_graphics/toolbar/stock_save_24.png \
wsug_graphics/toolbar/stock_save_as_24.png \
wsug_graphics/toolbar/stock_search_24.png \
wsug_graphics/toolbar/stock_stop_24.png \
wsug_graphics/toolbar/stock_top_24.png \
wsug_graphics/toolbar/stock_zoom_1_24.png \
wsug_graphics/toolbar/stock_zoom_in_24.png \
wsug_graphics/toolbar/stock_zoom_out_24.png
WSDG_FILES = \
wsdg_src/WSDG_chapter_build_intro.asciidoc \
wsdg_src/WSDG_chapter_capture.asciidoc \
wsdg_src/WSDG_chapter_dissection.asciidoc \
wsdg_src/WSDG_chapter_env_intro.asciidoc \
wsdg_src/WSDG_chapter_libraries.asciidoc \
wsdg_src/WSDG_chapter_quick_setup.asciidoc \
wsdg_src/WSDG_chapter_sources.asciidoc \
wsdg_src/WSDG_chapter_tools.asciidoc \
wsdg_src/WSDG_chapter_userinterface.asciidoc \
wsdg_src/WSDG_chapter_works.asciidoc \
wsdg_src/WSDG_preface.asciidoc \
wsluarm.asciidoc \
ws.css
WSDG_GENERATED_SOURCE = \
developer-guide.xml
WSDG_GRAPHICS = \
wsdg_graphics/ws-capture-sync.dia \
wsdg_graphics/ws-capture-sync.png \
wsdg_graphics/ws-capture_internals.dia \
wsdg_graphics/ws-capture_internals.png \
wsdg_graphics/ws-function-blocks.dia \
wsdg_graphics/ws-function-blocks.png \
wsdg_graphics/ws-logo.png \
wsdg_graphics/toolbar/dummy.dummy
WSUG+WSDG: Add a typographic conventions section. Create a common_src directory for common guide content. Add a typographic convention section. Update some of the content accordingly. Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e Reviewed-on: https://code.wireshark.org/review/23131 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-18 19:32:17 +00:00
COMMON_FILES = \
common_src/GPL_appendix.asciidoc \
common_src/typographic_conventions.asciidoc
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
COMMON_GRAPHICS = \
common_graphics/note.svg \
common_graphics/tip.svg \
common_graphics/warning.svg
# user-guide.xml must be first in the list (to match $<)
WSUG_DIST = \
user-guide.asciidoc \
AsciiDoc: Create an include file for attributes. Move the replacement definitions in asciidoc.conf to attributes.asciidoc. This makes the markup a bit cleaner and is more compatible with AsciiDoctor. Use a standard naming scheme for URLs. Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f Reviewed-on: https://code.wireshark.org/review/18655 Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-11-01 21:35:29 +00:00
attributes.asciidoc \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
custom_layer_chm.xsl \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
custom_layer_single_html.xsl \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
$(WSUG_FILES) \
Docbook: Automatically generate the tools help output. Add a CMake target that dumps the help output for our command line tools to individual files. Include those files in the tools appendix instead of pasting them in manually. Fixup the output of some tools so that they pass the pre-commit checks. Change-Id: I925f24818422a190927a96531c21f4d16d3fe5b5 Reviewed-on: https://code.wireshark.org/review/23737 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-09-25 21:06:37 +00:00
$(WSUG_TOOLS_HELP_FILES) \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
$(WSUG_GRAPHICS) \
WSUG+WSDG: Add a typographic conventions section. Create a common_src directory for common guide content. Add a typographic convention section. Update some of the content accordingly. Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e Reviewed-on: https://code.wireshark.org/review/23131 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-18 19:32:17 +00:00
$(COMMON_FILES) \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
$(COMMON_GRAPHICS)
WSUG_SOURCE = $(WSUG_GENERATED_SOURCE) $(WSUG_DIST)
# developer-guide.asciidoc must be first in the list (to match $<)
WSDG_DIST = \
developer-guide.asciidoc \
AsciiDoc: Create an include file for attributes. Move the replacement definitions in asciidoc.conf to attributes.asciidoc. This makes the markup a bit cleaner and is more compatible with AsciiDoctor. Use a standard naming scheme for URLs. Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f Reviewed-on: https://code.wireshark.org/review/18655 Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-11-01 21:35:29 +00:00
attributes.asciidoc \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
custom_layer_chm.xsl \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
custom_layer_single_html.xsl \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
$(WSDG_FILES) \
$(WSDG_GRAPHICS) \
WSUG+WSDG: Add a typographic conventions section. Create a common_src directory for common guide content. Add a typographic convention section. Update some of the content accordingly. Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e Reviewed-on: https://code.wireshark.org/review/23131 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-18 19:32:17 +00:00
$(COMMON_FILES) \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
$(COMMON_GRAPHICS)
WSDG_SOURCE = $(WSDG_GENERATED_SOURCE) $(WSDG_DIST)
RELEASE_NOTES_SOURCE = \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
release-notes.asciidoc
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
CLEANFILES = \
*.chm \
*.fo \
*.hhc \
*.hhp \
*.pdf \
$(WSDG_GENERATED_SOURCE) \
$(WSUG_GENERATED_SOURCE) \
wsdg_chm \
wsdg_html.zip \
wsdg_html_chunked.zip \
wsug_chm \
wsug_html.zip \
wsug_html_chunked.zip \
htmlhelp.* \
release_notes_chm \
release-notes.html \
release-notes.txt \
user-guide.zip \
wsluarm
CLEANDIRS = \
wsdg_html \
wsdg_html_chunked \
wsug_html \
wsug_html_chunked \
wsluarm_src
# Note: file order here MATTERS!
# new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE
# files for the same module
WSLUA_MODULES = \
$(top_srcdir)/epan/wslua/wslua_dumper.c \
$(top_srcdir)/epan/wslua/wslua_field.c \
$(top_srcdir)/epan/wslua/wslua_gui.c \
$(top_srcdir)/epan/wslua/wslua_listener.c \
$(top_srcdir)/epan/wslua/wslua_pinfo.c \
$(top_srcdir)/epan/wslua/wslua_address.c \
$(top_srcdir)/epan/wslua/wslua_column.c \
$(top_srcdir)/epan/wslua/wslua_nstime.c \
$(top_srcdir)/epan/wslua/wslua_proto.c \
$(top_srcdir)/epan/wslua/wslua_dissector.c \
$(top_srcdir)/epan/wslua/wslua_pref.c \
$(top_srcdir)/epan/wslua/wslua_proto_expert.c \
$(top_srcdir)/epan/wslua/wslua_proto_field.c \
$(top_srcdir)/epan/wslua/wslua_int64.c \
$(top_srcdir)/epan/wslua/wslua_struct.c \
$(top_srcdir)/epan/wslua/wslua_tree.c \
$(top_srcdir)/epan/wslua/wslua_tvb.c \
$(top_srcdir)/epan/wslua/wslua_byte_array.c \
$(top_srcdir)/epan/wslua/wslua_file.c \
$(top_srcdir)/epan/wslua/wslua_file_handler.c \
$(top_srcdir)/epan/wslua/wslua_frame_info.c \
$(top_srcdir)/epan/wslua/wslua_capture_info.c \
$(top_srcdir)/epan/wslua/wslua_dir.c \
$(top_srcdir)/epan/wslua/wslua_util.c
COMMON_XSLTPROC_ARGS = \
--stringparam use.id.as.filename 1 \
--stringparam admon.graphics 1 \
--stringparam admon.graphics.extension .svg \
--stringparam section.autolabel 1 \
--stringparam section.label.includes.component.label 1 \
--stringparam html.stylesheet ws.css
WSUG_XSLTPROC_ARGS = \
--stringparam admon.graphics.path wsug_graphics/
WSDG_XSLTPROC_ARGS = \
--stringparam admon.graphics.path wsdg_graphics/
SINGLE_XSLTPROC_ARGS = \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
--nonet custom_layer_single_html.xsl
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
CHUNKED_XSLTPROC_ARGS = \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
--stringparam chunker.output.encoding UTF-8 \
Remove Makefile.common files Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-21 04:06:23 +00:00
--nonet http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
HTMLHELP_XSLTPROC_ARGS = \
--nonet custom_layer_chm.xsl
# --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl
split docbook generation makefiles into nmake and GNU make variants (together with Makefile.common), just like all the other directories have it. This way makes it easier to get settings from config.nmake and probably makefile.am will be easier to do. In addition we don't need GNU make for Win32 generation. svn path=/trunk/; revision=20613
2007-01-29 22:15:13 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
ASCIIDOCTOR_COMMON_ARGS = \
--require $(srcdir)/asciidoctor-macros/commaize-block.rb \
--require $(srcdir)/asciidoctor-macros/cve_idlink-inline-macro.rb \
--require $(srcdir)/asciidoctor-macros/ws_buglink-inline-macro.rb \
--require $(srcdir)/asciidoctor-macros/ws_salink-inline-macro.rb
ASCIIDOCTOR_COMMON_COMMAND = TZ=UTC ASCIIDOCTORJ_OPTS="-Xmx800m ${ASCIIDOCTORJ_OPTS}" \
$(ASCIIDOCTOR) \
$(ASCIIDOCTOR_COMMON_ARGS)
.asciidoc.pdf:
$(ASCIIDOCTOR_COMMON_COMMAND) --backend pdf --out-file $@ $<
.asciidoc.xml:
$(ASCIIDOCTOR_COMMON_COMMAND) --backend docbook --out-file $@ $<
from Joerg Mayer: go towards "normal" makefile. svn path=/trunk/; revision=13734
2005-03-12 11:10:23 +00:00
autotools: Build and install user guide Installs the WSUG to $docdir, unless the --disable-guides option is given to the configure script. This will open the Help->Contents menu action using the locally installed guide. It will also point to the correct version for this Wireshark release. The wireshark.org link only provides the guide for the master branch. Change-Id: I9dd539c737cb3777dc1351707b9e45a3a6764aaa Reviewed-on: https://code.wireshark.org/review/23906 Petri-Dish: João Valverde <j@v6e.pt> Reviewed-by: João Valverde <j@v6e.pt> Tested-by: João Valverde <j@v6e.pt> Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-10-14 19:11:24 +00:00
docbook_all_local_targets =
if BUILD_USER_GUIDE
docbook_all_local_targets += wsug_html_chunked
all-local: $(docbook_all_local_targets)
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
all-html: wsug wsdg release_notes
from Joerg Mayer: go towards "normal" makefile. svn path=/trunk/; revision=13734
2005-03-12 11:10:23 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
all-pdf: wsug_pdf wsdg_pdf
add a simplified overview section about the Ethereal function blocks. Some cleanup in the docbook Makefile svn path=/trunk/; revision=12447
2004-10-30 12:54:53 +00:00
Clean up the makefile a bit. svn path=/trunk/; revision=31140
2009-12-01 07:27:03 +00:00
# Wireshark User Guide
autotools: docbook build improvements Let the make recipe fail if a dependency is missing. That is more user-friendly (a2x: command not found) than an empty target and having to re-run configure. Test for both w3m and lynx when generating text files. If neither is available skip it. Add an explicit target to build pdf documentation. Change-Id: I760475acd7278f5ab5a782c1828a134c58cf7b42 Reviewed-on: https://code.wireshark.org/review/15229 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-04-29 21:50:04 +00:00
wsug: wsug_html_chunked wsug_html
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
wsug_pdf: wsug user-guide.pdf
user-guide.xml: user-guide.asciidoc $(WSUG_FILES)
from Joerg Mayer: go towards "normal" makefile. svn path=/trunk/; revision=13734
2005-03-12 11:10:23 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
user-guide.pdf: user-guide.asciidoc $(WSUG_FILES)
endif
Finish converting the User's Guide to AsciiDoc. As with the Developer's Guide, add user-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in user-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Remove the various makefile targets for converting AsciiDoc files to DocBook chapters. Remove GPL_appendix.xml. We use the AsciiDoc version. Change-Id: I543fa2a92f2c735c5f00c97ec65cff2187e09e3a Reviewed-on: https://code.wireshark.org/review/5216 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-10 02:13:57 +00:00
Svn stuff: - Add eol-style native to all text files - Add Id attributes Add $Id: $ to all text files Makefile: - add several files and directories to make clean - Add comments for values on Suse 9.1 catalog.xml: - Add comments for values on Suse 9.1 svn path=/trunk/; revision=11618
2004-08-06 21:06:27 +00:00
# create html single page file
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
if BUILD_USER_GUIDE
Have docbook/Makefile.nmake use index.html similar to r51021. Make some target names less confusing. svn path=/trunk/; revision=51032
2013-07-30 17:57:20 +00:00
wsug_html: wsug_html/index.html
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
endif
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
wsug_html/index.html: user-guide.xml
EUG -> WSUG svn path=/trunk/; revision=18256
2006-05-30 19:45:12 +00:00
@ echo --- WSUG - HTML SINGLE PAGE ---
rename "graphics" directory to "wsug_graphics" to make it clear that it's only used for the users_guide svn path=/trunk/; revision=18473
2006-06-15 14:18:03 +00:00
mkdir -p wsug_html/wsug_graphics/toolbar
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
cp $(srcdir)/wsug_graphics/*.* wsug_html/wsug_graphics
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
cp $(srcdir)/common_graphics/*.* wsug_html/wsug_graphics
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
cp $(srcdir)/wsug_graphics/toolbar/* wsug_html/wsug_graphics/toolbar
cp $(srcdir)/ws.css wsug_html
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
$(XSLTPROC) --stringparam base.dir wsug_html/ $(COMMON_XSLTPROC_ARGS) \
Fix admon.graphics.path. Change-Id: I43d7d56f0fc2bd73efc54a685aea90f635b145ff Reviewed-on: https://code.wireshark.org/review/3807 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 05:21:38 +00:00
$(WSUG_XSLTPROC_ARGS) $(SINGLE_XSLTPROC_ARGS) $< > $@
eug -> wsug svn path=/trunk/; revision=18259
2006-05-30 21:34:56 +00:00
-chmod -R og+rX wsug_html
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
Svn stuff: - Add eol-style native to all text files - Add Id attributes Add $Id: $ to all text files Makefile: - add several files and directories to make clean - Add comments for values on Suse 9.1 catalog.xml: - Add comments for values on Suse 9.1 svn path=/trunk/; revision=11618
2004-08-06 21:06:27 +00:00
# create html chunked page files
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
if BUILD_USER_GUIDE
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
wsug_html_chunked: wsug_html_chunked/index.html
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
endif
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
wsug_html_chunked/index.html: user-guide.xml
EUG -> WSUG svn path=/trunk/; revision=18256
2006-05-30 19:45:12 +00:00
@ echo --- WSUG - HTML CHUNKED ---
rename "graphics" directory to "wsug_graphics" to make it clear that it's only used for the users_guide svn path=/trunk/; revision=18473
2006-06-15 14:18:03 +00:00
mkdir -p wsug_html_chunked/wsug_graphics/toolbar
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
cp $(srcdir)/wsug_graphics/*.* wsug_html_chunked/wsug_graphics
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
cp $(srcdir)/common_graphics/*.* wsug_html_chunked/wsug_graphics
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
cp $(srcdir)/wsug_graphics/toolbar/* wsug_html_chunked/wsug_graphics/toolbar
cp $(srcdir)/ws.css wsug_html_chunked
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
$(XSLTPROC) --stringparam base.dir wsug_html_chunked/ $(COMMON_XSLTPROC_ARGS) \
Fix admon.graphics.path. Change-Id: I43d7d56f0fc2bd73efc54a685aea90f635b145ff Reviewed-on: https://code.wireshark.org/review/3807 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 05:21:38 +00:00
$(WSUG_XSLTPROC_ARGS) $(CHUNKED_XSLTPROC_ARGS) $<
eug -> wsug svn path=/trunk/; revision=18259
2006-05-30 21:34:56 +00:00
-chmod -R og+rX wsug_html_chunked
Svn stuff: - Add eol-style native to all text files - Add Id attributes Add $Id: $ to all text files Makefile: - add several files and directories to make clean - Add comments for values on Suse 9.1 catalog.xml: - Add comments for values on Suse 9.1 svn path=/trunk/; revision=11618
2004-08-06 21:06:27 +00:00
Clean up the makefile a bit. svn path=/trunk/; revision=31140
2009-12-01 07:27:03 +00:00
wsluarm: make-wsluarm.pl $(WSLUA_MODULES)
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
mkdir -p wsluarm_src
$(PERL) $(srcdir)/make-wsluarm.pl $(WSLUA_MODULES)
Clean up the makefile a bit. svn path=/trunk/; revision=31140
2009-12-01 07:27:03 +00:00
touch wsluarm
very first steps for a "new" developer's guide svn path=/trunk/; revision=11761
2004-08-17 17:09:14 +00:00
Clean up the makefile a bit. svn path=/trunk/; revision=31140
2009-12-01 07:27:03 +00:00
# Wireshark Developer Guide
autotools: docbook build improvements Let the make recipe fail if a dependency is missing. That is more user-friendly (a2x: command not found) than an empty target and having to re-run configure. Test for both w3m and lynx when generating text files. If neither is available skip it. Add an explicit target to build pdf documentation. Change-Id: I760475acd7278f5ab5a782c1828a134c58cf7b42 Reviewed-on: https://code.wireshark.org/review/15229 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-04-29 21:50:04 +00:00
wsdg: wsdg_html_chunked wsdg_html
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
if BUILD_USER_GUIDE
wsdg_pdf: developer-guide.pdf
endif
add a simplified overview section about the Ethereal function blocks. Some cleanup in the docbook Makefile svn path=/trunk/; revision=12447
2004-10-30 12:54:53 +00:00
automake: fix wslua generation in out-of-source-tree builds. We neeed to set the build directory (because that's where the wslua stuff gets put). Also fix up wslua dependencies: - It's needed (only) for the asciidoc->XML step - It's not needed for the wsug any more Change-Id: Ic1231a964b1edfb7d2eeacc5cc1c3fdda6969f21 Reviewed-on: https://code.wireshark.org/review/15407 Petri-Dish: Jeff Morriss <jeff.morriss.ws@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2016-05-12 20:49:45 +00:00
developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES) wsluarm
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
developer-guide.pdf: developer-guide.asciidoc $(WSDG_FILES) wsluarm
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
added a lot of content about the build environment, as the required tools, libraries and such (much win32 related stuff). doc is still at a *very* early stage and still very incomplete, but constantly growing now :-) svn path=/trunk/; revision=11786
2004-08-21 16:30:04 +00:00
# create html single page file
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
if BUILD_USER_GUIDE
automake: fix wslua generation in out-of-source-tree builds. We neeed to set the build directory (because that's where the wslua stuff gets put). Also fix up wslua dependencies: - It's needed (only) for the asciidoc->XML step - It's not needed for the wsug any more Change-Id: Ic1231a964b1edfb7d2eeacc5cc1c3fdda6969f21 Reviewed-on: https://code.wireshark.org/review/15407 Petri-Dish: Jeff Morriss <jeff.morriss.ws@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2016-05-12 20:49:45 +00:00
wsdg_html: wsdg_html/index.html
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
endif
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
wsdg_html/index.html: developer-guide.xml
edg -> wsdg -This line, and those below, will be ignored-- D docbook/edg_graphics M docbook/developer-guide.xml M docbook/Makefile.auto.am A docbook/wsdg_graphics D docbook/edg_src M docbook/README.txt A docbook/wsdg_src D docbook/wsdg_src/EDG_meta_info.xml A docbook/wsdg_src/WSDG_userinterface.xml D docbook/wsdg_src/EDG_preface.xml D docbook/wsdg_src/EDG_chapter_userinterface.xml D docbook/wsdg_src/EDG_chapter_tools.xml A docbook/wsdg_src/WSDG_meta_info.xml D docbook/wsdg_src/EDG_chapter_env_intro.xml D docbook/wsdg_src/EDG_chapter_capture.xml A docbook/wsdg_src/WSDG_preface.xml A docbook/wsdg_src/WSDG_works.xml D docbook/wsdg_src/EDG_chapter_dissection.xml A docbook/wsdg_src/WSDG_chapter_tools.xml D docbook/wsdg_src/EDG_chapter_works.xml A docbook/wsdg_src/WSDG_chapter_env_intro.xml A docbook/wsdg_src/WSDG_chapter_capture.xml A docbook/wsdg_src/WSDG_chapter_dissection.xml D docbook/wsdg_src/EDG_chapter_build_intro.xml D docbook/wsdg_src/EDG_chapter_libraries.xml A docbook/wsdg_src/WSDG_chapter_build_intro.xml A docbook/wsdg_src/WSDG_chapter_libraries.xml D docbook/wsdg_src/EDG_chapter_sources.xml A docbook/wsdg_src/WSDG_chapter_sources.xml M docbook/Makefile svn path=/trunk/; revision=18368
2006-06-06 23:08:58 +00:00
@ echo --- WSDG - HTML SINGLE PAGE ---
wsdg_graphics/toolbar is a directory; fix the rules that weren't already fixed to cope with that. svn path=/trunk/; revision=39021
2011-09-16 00:21:21 +00:00
mkdir -p wsdg_html/wsdg_graphics/toolbar
cp $(srcdir)/wsdg_graphics/*.* wsdg_html/wsdg_graphics
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
cp $(srcdir)/common_graphics/*.* wsdg_html/wsdg_graphics
Support out-of-source docbook build Change-Id: I273a6317c459664a247d3f5623ef54b0a70a9ab8 Reviewed-on: https://code.wireshark.org/review/2232 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-06-15 17:39:09 +00:00
cp $(srcdir)/wsdg_graphics/toolbar/* wsdg_html/wsdg_graphics/toolbar/
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
cp $(srcdir)/ws.css wsdg_html
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
$(XSLTPROC) --stringparam base.dir wsdg_html/ $(COMMON_XSLTPROC_ARGS) \
Convert the Lua reference to AsciiDoc. Move it to the Developer's Guide while we're here. Nudge the markup in epan/wslua where needed. Note that we should probably convert it to AsciiDoc (if we're going to keep it in the DG) or Doxygen. Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b Reviewed-on: https://code.wireshark.org/review/5203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-02 21:20:08 +00:00
--path .:wsluarm_src \
Fix admon.graphics.path. Change-Id: I43d7d56f0fc2bd73efc54a685aea90f635b145ff Reviewed-on: https://code.wireshark.org/review/3807 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 05:21:38 +00:00
$(WSDG_XSLTPROC_ARGS) $(SINGLE_XSLTPROC_ARGS) $< > $@
edg -> wsdg -This line, and those below, will be ignored-- D docbook/edg_graphics M docbook/developer-guide.xml M docbook/Makefile.auto.am A docbook/wsdg_graphics D docbook/edg_src M docbook/README.txt A docbook/wsdg_src D docbook/wsdg_src/EDG_meta_info.xml A docbook/wsdg_src/WSDG_userinterface.xml D docbook/wsdg_src/EDG_preface.xml D docbook/wsdg_src/EDG_chapter_userinterface.xml D docbook/wsdg_src/EDG_chapter_tools.xml A docbook/wsdg_src/WSDG_meta_info.xml D docbook/wsdg_src/EDG_chapter_env_intro.xml D docbook/wsdg_src/EDG_chapter_capture.xml A docbook/wsdg_src/WSDG_preface.xml A docbook/wsdg_src/WSDG_works.xml D docbook/wsdg_src/EDG_chapter_dissection.xml A docbook/wsdg_src/WSDG_chapter_tools.xml D docbook/wsdg_src/EDG_chapter_works.xml A docbook/wsdg_src/WSDG_chapter_env_intro.xml A docbook/wsdg_src/WSDG_chapter_capture.xml A docbook/wsdg_src/WSDG_chapter_dissection.xml D docbook/wsdg_src/EDG_chapter_build_intro.xml D docbook/wsdg_src/EDG_chapter_libraries.xml A docbook/wsdg_src/WSDG_chapter_build_intro.xml A docbook/wsdg_src/WSDG_chapter_libraries.xml D docbook/wsdg_src/EDG_chapter_sources.xml A docbook/wsdg_src/WSDG_chapter_sources.xml M docbook/Makefile svn path=/trunk/; revision=18368
2006-06-06 23:08:58 +00:00
-chmod -R og+rX wsdg_html
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
very first steps for a "new" developer's guide svn path=/trunk/; revision=11761
2004-08-17 17:09:14 +00:00
# create html chunked page files
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
if BUILD_USER_GUIDE
wsdg_html_chunked: developer-guide.xml wsdg_html_chunked/index.html
endif
fix bug #842: "make" now won't try to rebuild again if nothing changed since the last make call. Other minor dependency fixes. I didn't found a way to implement the SVN version check using make, so using a new shell script instead ... svn path=/trunk/; revision=19173
2006-09-07 20:01:07 +00:00
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
wsdg_html_chunked/index.html: developer-guide.xml
edg -> wsdg -This line, and those below, will be ignored-- D docbook/edg_graphics M docbook/developer-guide.xml M docbook/Makefile.auto.am A docbook/wsdg_graphics D docbook/edg_src M docbook/README.txt A docbook/wsdg_src D docbook/wsdg_src/EDG_meta_info.xml A docbook/wsdg_src/WSDG_userinterface.xml D docbook/wsdg_src/EDG_preface.xml D docbook/wsdg_src/EDG_chapter_userinterface.xml D docbook/wsdg_src/EDG_chapter_tools.xml A docbook/wsdg_src/WSDG_meta_info.xml D docbook/wsdg_src/EDG_chapter_env_intro.xml D docbook/wsdg_src/EDG_chapter_capture.xml A docbook/wsdg_src/WSDG_preface.xml A docbook/wsdg_src/WSDG_works.xml D docbook/wsdg_src/EDG_chapter_dissection.xml A docbook/wsdg_src/WSDG_chapter_tools.xml D docbook/wsdg_src/EDG_chapter_works.xml A docbook/wsdg_src/WSDG_chapter_env_intro.xml A docbook/wsdg_src/WSDG_chapter_capture.xml A docbook/wsdg_src/WSDG_chapter_dissection.xml D docbook/wsdg_src/EDG_chapter_build_intro.xml D docbook/wsdg_src/EDG_chapter_libraries.xml A docbook/wsdg_src/WSDG_chapter_build_intro.xml A docbook/wsdg_src/WSDG_chapter_libraries.xml D docbook/wsdg_src/EDG_chapter_sources.xml A docbook/wsdg_src/WSDG_chapter_sources.xml M docbook/Makefile svn path=/trunk/; revision=18368
2006-06-06 23:08:58 +00:00
@ echo --- WSDG - HTML CHUNKED ---
wsdg_graphics/toolbar is a directory; fix the rules that weren't already fixed to cope with that. svn path=/trunk/; revision=39021
2011-09-16 00:21:21 +00:00
mkdir -p wsdg_html_chunked/wsdg_graphics/toolbar
cp $(srcdir)/wsdg_graphics/*.* wsdg_html_chunked/wsdg_graphics
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
cp $(srcdir)/common_graphics/*.* wsdg_html_chunked/wsdg_graphics
Support out-of-source docbook build Change-Id: I273a6317c459664a247d3f5623ef54b0a70a9ab8 Reviewed-on: https://code.wireshark.org/review/2232 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-06-15 17:39:09 +00:00
cp $(srcdir)/wsdg_graphics/toolbar/* wsdg_html_chunked/wsdg_graphics/toolbar/
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
cp $(srcdir)/ws.css wsdg_html_chunked
Convert admon graphics to SVG. Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-24 01:28:32 +00:00
$(XSLTPROC) --stringparam base.dir wsdg_html_chunked/ $(COMMON_XSLTPROC_ARGS) \
Convert the Lua reference to AsciiDoc. Move it to the Developer's Guide while we're here. Nudge the markup in epan/wslua where needed. Note that we should probably convert it to AsciiDoc (if we're going to keep it in the DG) or Doxygen. Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b Reviewed-on: https://code.wireshark.org/review/5203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-02 21:20:08 +00:00
--path .:wsluarm_src \
Fix admon.graphics.path. Change-Id: I43d7d56f0fc2bd73efc54a685aea90f635b145ff Reviewed-on: https://code.wireshark.org/review/3807 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 05:21:38 +00:00
$(WSDG_XSLTPROC_ARGS) $(CHUNKED_XSLTPROC_ARGS) $<
edg -> wsdg -This line, and those below, will be ignored-- D docbook/edg_graphics M docbook/developer-guide.xml M docbook/Makefile.auto.am A docbook/wsdg_graphics D docbook/edg_src M docbook/README.txt A docbook/wsdg_src D docbook/wsdg_src/EDG_meta_info.xml A docbook/wsdg_src/WSDG_userinterface.xml D docbook/wsdg_src/EDG_preface.xml D docbook/wsdg_src/EDG_chapter_userinterface.xml D docbook/wsdg_src/EDG_chapter_tools.xml A docbook/wsdg_src/WSDG_meta_info.xml D docbook/wsdg_src/EDG_chapter_env_intro.xml D docbook/wsdg_src/EDG_chapter_capture.xml A docbook/wsdg_src/WSDG_preface.xml A docbook/wsdg_src/WSDG_works.xml D docbook/wsdg_src/EDG_chapter_dissection.xml A docbook/wsdg_src/WSDG_chapter_tools.xml D docbook/wsdg_src/EDG_chapter_works.xml A docbook/wsdg_src/WSDG_chapter_env_intro.xml A docbook/wsdg_src/WSDG_chapter_capture.xml A docbook/wsdg_src/WSDG_chapter_dissection.xml D docbook/wsdg_src/EDG_chapter_build_intro.xml D docbook/wsdg_src/EDG_chapter_libraries.xml A docbook/wsdg_src/WSDG_chapter_build_intro.xml A docbook/wsdg_src/WSDG_chapter_libraries.xml D docbook/wsdg_src/EDG_chapter_sources.xml A docbook/wsdg_src/WSDG_chapter_sources.xml M docbook/Makefile svn path=/trunk/; revision=18368
2006-06-06 23:08:58 +00:00
-chmod -R og+rX wsdg_html_chunked
very first steps for a "new" developer's guide svn path=/trunk/; revision=11761
2004-08-17 17:09:14 +00:00
autotools: docbook build improvements Let the make recipe fail if a dependency is missing. That is more user-friendly (a2x: command not found) than an empty target and having to re-run configure. Test for both w3m and lynx when generating text files. If neither is available skip it. Add an explicit target to build pdf documentation. Change-Id: I760475acd7278f5ab5a782c1828a134c58cf7b42 Reviewed-on: https://code.wireshark.org/review/15229 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-04-29 21:50:04 +00:00
# Release notes
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
if HAVE_ASCIIDOCTOR
release_note_deps = release-notes.html
release_note_deps += release-notes.txt
endif
release_notes: $(release_note_deps)
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
Add release notes. The content still needs to be filled in. svn path=/trunk/; revision=15134
2005-07-28 14:29:19 +00:00
# create html single page file
release-notes.html: $(RELEASE_NOTES_SOURCE)
@ echo --- RELEASE NOTES - HTML ---
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
$(ASCIIDOCTOR_COMMON_COMMAND) \
--backend html \
--out-file $(builddir)/release-notes.html \
automake: get docbook builds working for out of (source) tree builds. Change-Id: I483596d21f072b97ae87d5032bd450adcafcf243 Reviewed-on: https://code.wireshark.org/review/10678 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-09-28 16:50:13 +00:00
$(srcdir)/release-notes.asciidoc
Add a "release-notes.txt" target. svn path=/trunk/; revision=16910
2005-12-27 22:22:14 +00:00
first step to fix the file dialog "mess": - use different screenshots for: GTK1, GTK2 and Win32 - rewrite the "File Open Dialog" section svn path=/trunk/; revision=19239
2006-09-15 22:56:15 +00:00
# create txt single page file (through HTML)
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
release-notes.txt: release-notes.html
fix a make display bug svn path=/trunk/; revision=17892
2006-04-18 00:55:06 +00:00
@ echo --- RELEASE NOTES - TXT ---
Remove Lynx. Use tools/html2text.py to convert HTML to text. Remove some now-obsolete documentation. Change-Id: Ib21a1ab10c789182da5fcc68e98917a00f2fa650 Reviewed-on: https://code.wireshark.org/review/25733 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-11 19:03:56 +00:00
$(PYTHON) $(srcdir)/tools/html2text.py \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
$(builddir)/release-notes.html \
> $(builddir)/release-notes.txt
The contents of the NEWS file come from the release notes. Back-port the changes in r20642 to release-notes.xml. Add "news" targes to the docbook makefiles to copy release-notes.txt to NEWS. svn path=/trunk/; revision=20669
2007-02-01 18:35:14 +00:00
news: release-notes.txt
Support building the NEWS file in out-of-source-tree builds. Copy the built file into the source directory (since it's generated but checked in). Don't fail to build, though, if we can't do that copy. Change-Id: Ia94a19b6f813ee78b191cd09d51198462f95b223 Reviewed-on: https://code.wireshark.org/review/3425 Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2014-08-04 23:08:05 +00:00
cp release-notes.txt ../NEWS
Add a few more NEWS items. Fix a typo in the generation of top_srcdir NEWS. Change-Id: I20a140a68b9afca5096d33d99a3ea5d24e776f05 Reviewed-on: https://code.wireshark.org/review/3626 Tested-by: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2014-08-15 18:20:01 +00:00
-cp release-notes.txt $(top_srcdir)/NEWS
The contents of the NEWS file come from the release notes. Back-port the changes in r20642 to release-notes.xml. Add "news" targes to the docbook makefiles to copy release-notes.txt to NEWS. svn path=/trunk/; revision=20669
2007-02-01 18:35:14 +00:00
autotools: Build and install user guide Installs the WSUG to $docdir, unless the --disable-guides option is given to the configure script. This will open the Help->Contents menu action using the locally installed guide. It will also point to the correct version for this Wireshark release. The wireshark.org link only provides the guide for the master branch. Change-Id: I9dd539c737cb3777dc1351707b9e45a3a6764aaa Reviewed-on: https://code.wireshark.org/review/23906 Petri-Dish: João Valverde <j@v6e.pt> Reviewed-by: João Valverde <j@v6e.pt> Tested-by: João Valverde <j@v6e.pt> Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-10-14 19:11:24 +00:00
install-data-local:
if BUILD_USER_GUIDE
$(MKDIR_P) $(DESTDIR)$(docdir)/guides
cp -rf $(builddir)/wsug_html_chunked $(DESTDIR)$(docdir)/guides
endif
uninstall-local:
rm -rf $(DESTDIR)$(docdir)
Use automake to build things in docbook/ . This at least gets the docbook source distributed, as requested in: https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=3871 Still to do: 1) get out-of-source-tree builds working 2) automatically check that everything is distributed with distcheck (requires (1) but it may also require building the docbook directory as part of "make all") 3) (optional) use automake rules to actually build the stuff (currently Makefile.am is basically some automake stuff wrapped around standard Makefile rules. Could this done better?) svn path=/trunk/; revision=31858
2010-02-10 22:12:22 +00:00
clean-local:
-rm -rf $(CLEANDIRS)
Add Cmake stuff to the source distribution so more people can try it out. svn path=/trunk/; revision=32807
2010-05-14 16:27:03 +00:00
EXTRA_DIST = \
Start converting the User's Guide to AsciiDoc. Convert the preface and introduction. Update various makefiles. Change-Id: Id998cabadb6de458f04b7a43bdba4f98e4edb052 Reviewed-on: https://code.wireshark.org/review/3139 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-07-17 01:38:42 +00:00
$(WSUG_DIST) \
Start migrating the Developer's Guide to AsciiDoc. So far only one chapter (WSDG_chapter_sources) has been converted. Conversion was done using the script in https://code.wireshark.org/review/#/c/9/ along with manual cleanup. Changes are mostly limited formatting. It's helpful to have a copy of the pre-conversion guide for comparison. I've placed a chunked copy online at http://www.wireshark.org/~gerald/wsdg_html_2014_01/ . Tested under Autotools. Nmake and CMake will likely break. I'll take a look shortly. If only we had documention adding a feature branch to Gerrit and using it to test different platforms... svn path=/trunk/; revision=54945
2014-01-24 18:55:27 +00:00
$(WSDG_DIST) \
Fix dist. Add asciidoctor-macros. Change-Id: Ib3ee30f6da69bad585028eb8f1274a052114630b Reviewed-on: https://code.wireshark.org/review/25734 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-11 19:59:09 +00:00
asciidoctor-macros \
Add Cmake stuff to the source distribution so more people can try it out. svn path=/trunk/; revision=32807
2010-05-14 16:27:03 +00:00
$(RELEASE_NOTES_SOURCE) \
make-wsluarm.pl \
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
README.adoc \
s/wsug_/wsdg_/g in the Developer's Guide targets. svn path=/trunk/; revision=39199
2011-09-30 16:55:41 +00:00
CMakeLists.txt