osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
wireshark/docbook/CMakeLists.txt

532 lines
16 KiB
CMake
Raw Normal View History

- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
# CMakeLists.txt
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
replace SPDX identifier GPL-2.0+ with GPL-2.0-or-later. The first is deprecated, as per https://spdx.org/licenses/. Change-Id: I8e21e1d32d09b8b94b93a2dc9fbdde5ffeba6bed Reviewed-on: https://code.wireshark.org/review/25661 Petri-Dish: Anders Broman <a.broman58@gmail.com> Petri-Dish: Dario Lombardo <lomato@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-07 11:26:45 +00:00
# SPDX-License-Identifier: GPL-2.0-or-later
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +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
# To do:
# - Make the build targets top-level on Windows, similar to the NSIS,
# WiX, and PortableApps targets?
find_package( Asciidoctor 1.5 )
find_package( XSLTPROC )
function(set_docbook_target_properties _target)
set_target_properties(${_target} PROPERTIES
CMake: Place all of the documentation in the "Documentation" folder.
2021-10-20 22:23:19 +00:00
FOLDER "Documentation"
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
EXCLUDE_FROM_DEFAULT_BUILD True
)
endfunction(set_docbook_target_properties)
CMake: Fix package requirements for building docs Make ASCIIDOC and XSLTPROC packages required if building any of the HTML, PDF or CHM guides. Don't attempt to build the release notes if ASCIIDOC isn't found. Change-Id: Id61653a635f91cbaffa32fb26ddbdbc568b74528 Reviewed-on: https://code.wireshark.org/review/24483 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-11-18 21:53:46 +00:00
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
set(COMMON_FILES
CMake: Lower-case a filename GPL_appendix.adoc should be gpl_appendix.adoc as of 171dbd6ea8.
2023-01-30 22:05:00 +00:00
common_src/gpl_appendix.adoc
WSDG/WSUG: add missing asciidoc admonition icons Closes #17474
2022-02-08 04:58:52 +00:00
common_src/typographic_conventions.adoc
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
)
CMake: Install the HTML guides. Add a "FileInstall.cmake" module that installs files and directories. Use it to install the chunked HTML guides. Install the guides into CMAKE_INSTALL_FULL_DOCDIR. By default this is /usr/local/share/doc/Wireshark. Define DOC_DIR to match. Add explicit file and directory permissions to the default install targets. Remove the PDF install target. Bug: 14258 Change-Id: I4712a4047a54627b7520b5bf5f191e0761d19606 Reviewed-on: https://code.wireshark.org/review/25737 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-11 22:34:04 +00:00
set(GUIDE_INSTALL_DIRS)
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
CMake: Use "'" instead of "’" in our guide filenames. Use an apostrophe instead of RIGHT SINGLE QUOTATION MARK in our PDF and EPUB filenames. Some programs (notably Okular) can't open filenames with extended characters, at least on Windows.
2021-08-26 22:44:23 +00:00
set(WSUG_TITLE "Wireshark User's Guide")
Docs: Give the PDF and EPUB guides descriptive filenames. Use the document title for our PDF and EPUB filenames under the theory that "Wireshark User’s Guide.pdf" is more obvious than "user-guide.pdf".
2021-08-03 20:42:20 +00:00
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
set(WSUG_FILES
Docs: Rename our guide source files Rename the various "WSUG_" and "WSDG_" files to wsug_ and wsdg_ respectively. Remove the "chapter" and "app" parts from the filenames as well.
2023-01-29 21:54:05 +00:00
wsug_src/wsug_advanced.adoc
wsug_src/wsug_build_install.adoc
wsug_src/wsug_capture.adoc
wsug_src/wsug_customize.adoc
wsug_src/wsug_files.adoc
wsug_src/wsug_howitworks.adoc
wsug_src/wsug_introduction.adoc
wsug_src/wsug_io.adoc
wsug_src/wsug_mate.adoc
wsug_src/wsug_messages.adoc
wsug_src/wsug_preface.adoc
wsug_src/wsug_protocols.adoc
wsug_src/wsug_statistics.adoc
wsug_src/wsug_telephony.adoc
wsug_src/wsug_tools.adoc
wsug_src/wsug_troubleshoot.adoc
wsug_src/wsug_use.adoc
wsug_src/wsug_work.adoc
Update tools help using a script. Update docbook/wsug_src/*.txt using tools/update-tools-help.py. This removes a lot of unwanted behavior that came with updating via a CMake target. Change-Id: I0a24f425e9673ef7bd074210d7047654c6755e79 Reviewed-on: https://code.wireshark.org/review/29416 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-09-04 20:03:48 +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
wsug_src/tshark-h.txt
WSUG: Automatically update wireshark --help output The update_tools_help CMake target is periodically run, but the output of `wireshark -h` was previously not included. Bug: 16166 Change-Id: Ib7aac89ff31d7b7c7033496b512d97bfbd727aaa Reviewed-on: https://code.wireshark.org/review/35205 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Dario Lombardo <lomato@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-25 03:41:49 +00:00
wsug_src/wireshark-h.txt
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}
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
)
Tools: Migrate compress-pngs.sh to Python. Migrate compress-pngs from a Bash script that ran Make to a Python script, which should be usable on more platforms. Add Efficient Compression Tool (ect) to the list of compressors. Add the compressors to the various *-setup.sh scripts, but comment them out for now.
2021-09-12 20:45:54 +00:00
# Note: Images should be minimized using tools/compress-pngs.py.
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
set(WSUG_GRAPHICS
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
wsug_src/images/caution.svg
wsug_src/images/important.svg
wsug_src/images/note.svg
wsug_src/images/related-ack.png
wsug_src/images/related-current.png
wsug_src/images/related-dup-ack.png
wsug_src/images/related-first.png
wsug_src/images/related-last.png
wsug_src/images/related-other.png
wsug_src/images/related-request.png
wsug_src/images/related-response.png
wsug_src/images/related-segment.png
wsug_src/images/tip.svg
wsug_src/images/toolbar/document-open.png
wsug_src/images/toolbar/edit-find.png
wsug_src/images/toolbar/filter-toolbar-add.png
wsug_src/images/toolbar/filter-toolbar-apply.png
wsug_src/images/toolbar/filter-toolbar-bookmark.png
wsug_src/images/toolbar/filter-toolbar-clear.png
wsug_src/images/toolbar/filter-toolbar-input.png
wsug_src/images/toolbar/filter-toolbar-recent.png
wsug_src/images/toolbar/go-first.png
wsug_src/images/toolbar/go-jump.png
wsug_src/images/toolbar/go-last.png
wsug_src/images/toolbar/go-next.png
wsug_src/images/toolbar/go-previous.png
wsug_src/images/toolbar/x-capture-file-close.png
wsug_src/images/toolbar/x-capture-file-reload.png
wsug_src/images/toolbar/x-capture-file-save.png
wsug_src/images/toolbar/x-capture-options.png
wsug_src/images/toolbar/x-capture-restart.png
wsug_src/images/toolbar/x-capture-start.png
wsug_src/images/toolbar/x-capture-stop.png
wsug_src/images/toolbar/x-colorize-packets.png
wsug_src/images/toolbar/x-resize-columns.png
wsug_src/images/toolbar/x-stay-last.png
wsug_src/images/toolbar/zoom-in.png
wsug_src/images/toolbar/zoom-original.png
wsug_src/images/toolbar/zoom-out.png
wsug_src/images/warning.svg
wsug_src/images/ws-about-codecs.png
wsug_src/images/ws-analyze-menu.png
wsug_src/images/ws-bytes-pane-popup-menu.png
wsug_src/images/ws-bytes-pane-tabs.png
wsug_src/images/ws-bytes-pane.png
wsug_src/images/ws-capture-file-properties.png
wsug_src/images/ws-capture-info.png
wsug_src/images/ws-capture-interfaces-main-macos.png
wsug_src/images/ws-capture-interfaces-main-win32.png
wsug_src/images/ws-capture-menu.png
wsug_src/images/ws-capture-options-compile-selected-bpfs.png
wsug_src/images/ws-capture-options-options.png
wsug_src/images/ws-capture-options-output.png
wsug_src/images/ws-capture-options-output.png
wsug_src/images/ws-capture-options.png
wsug_src/images/ws-choose-color-rule.png
wsug_src/images/ws-coloring-fields.png
wsug_src/images/ws-coloring-rules-dialog.png
wsug_src/images/ws-column-header-popup-menu.png
wsug_src/images/ws-decode-as.png
wsug_src/images/ws-details-pane-popup-menu.png
wsug_src/images/ws-details-pane.png
wsug_src/images/ws-diagram-pane-popup-menu.png
wsug_src/images/ws-diagram-pane.png
wsug_src/images/ws-display-filter-tcp.png # GTK+
wsug_src/images/ws-edit-menu.png
wsug_src/images/ws-enabled-protocols.png
wsug_src/images/ws-expert-colored-tree.png
wsug_src/images/ws-expert-column.png
wsug_src/images/ws-expert-information.png
wsug_src/images/ws-export-objects.png
wsug_src/images/ws-export-packet-dissections.png
wsug_src/images/ws-export-selected.png
wsug_src/images/ws-export-specified-packets.png
wsug_src/images/ws-file-import.png
wsug_src/images/ws-file-menu.png
wsug_src/images/ws-file-set-dialog.png # GTK+
wsug_src/images/ws-filter-add-expression.png # GTK+
wsug_src/images/ws-filter-toolbar.png
wsug_src/images/ws-filters.png # GTK+
wsug_src/images/ws-find-packet.png
wsug_src/images/ws-follow-http2-stream.png
wsug_src/images/ws-follow-sip-stream.png
wsug_src/images/ws-follow-stream.png
wsug_src/images/ws-go-menu.png
wsug_src/images/ws-goto-packet.png
wsug_src/images/ws-gui-preferences-advanced.png
wsug_src/images/ws-gui-preferences.png
wsug_src/images/ws-help-menu.png
wsug_src/images/ws-list-pane.png # Outdated
wsug_src/images/ws-main-toolbar.png
wsug_src/images/ws-main.png
wsug_src/images/ws-manage-interfaces.png
wsug_src/images/ws-mate-analysis.png
wsug_src/images/ws-mate-dns_pane.png
wsug_src/images/ws-mate-dns_pdu.png
wsug_src/images/ws-mate-ftp_over_gre.png
wsug_src/images/ws-mate-gop_analysis.png
wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png
wsug_src/images/ws-mate-mmse_over_http.png
wsug_src/images/ws-mate-pdu_analysis.png
wsug_src/images/ws-mate-tcp-output.png
wsug_src/images/ws-mate-transform.png
wsug_src/images/ws-menu.png
wsug_src/images/ws-merge-qt5.png
wsug_src/images/ws-merge-win32.png
wsug_src/images/ws-open-qt5.png
wsug_src/images/ws-open-win32.png
wsug_src/images/ws-packet-format.png
wsug_src/images/ws-packet-pane-popup-menu.png
wsug_src/images/ws-packet-range.png
wsug_src/images/ws-packet-selected.png
wsug_src/images/ws-packet-sep-win.png
wsug_src/images/ws-print.png
wsug_src/images/ws-save-as-qt5.png
wsug_src/images/ws-save-as-win32.png
wsug_src/images/ws-statistics-menu.png
wsug_src/images/ws-stats-conversations.png
wsug_src/images/ws-stats-endpoints.png
wsug_src/images/ws-stats-hierarchy.png
wsug_src/images/ws-stats-iographs.png
wsug_src/images/ws-stats-lte-mac-traffic.png
wsug_src/images/ws-stats-lte-rlc-traffic.png
wsug_src/images/ws-stats-packet-lengths.png
wsug_src/images/ws-stats-srt-smb2.png
wsug_src/images/ws-stats-wlan-traffic.png # GTK+
wsug_src/images/ws-statusbar-empty.png
wsug_src/images/ws-statusbar-filter.png
wsug_src/images/ws-statusbar-loaded.png
wsug_src/images/ws-statusbar-profile.png
wsug_src/images/ws-statusbar-selected.png
wsug_src/images/ws-tcp-analysis.png
wsug_src/images/ws-tel-playlist.png
wsug_src/images/ws-tel-rtp-player_1.png
wsug_src/images/ws-tel-rtp-player_2.png
wsug_src/images/ws-tel-rtp-player_3.png
wsug_src/images/ws-tel-rtp-player_button.png
wsug_src/images/ws-tel-rtp-streams.png
wsug_src/images/ws-tel-rtpstream-analysis_1.png
wsug_src/images/ws-tel-rtpstream-analysis_2.png
wsug_src/images/ws-tel-rtpstream-analysis_3.png
wsug_src/images/ws-tel-seq-dialog.png
wsug_src/images/ws-tel-voip-calls.png
wsug_src/images/ws-telephony-menu.png
wsug_src/images/ws-time-reference.png # GTK+
wsug_src/images/ws-tools-menu.png
wsug_src/images/ws-view-menu.png
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
)
CMake: Use "'" instead of "’" in our guide filenames. Use an apostrophe instead of RIGHT SINGLE QUOTATION MARK in our PDF and EPUB filenames. Some programs (notably Okular) can't open filenames with extended characters, at least on Windows.
2021-08-26 22:44:23 +00:00
set(WSDG_TITLE "Wireshark Developer's Guide")
Docs: Give the PDF and EPUB guides descriptive filenames. Use the document title for our PDF and EPUB filenames under the theory that "Wireshark User’s Guide.pdf" is more obvious than "user-guide.pdf".
2021-08-03 20:42:20 +00:00
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
set(WSDG_FILES
Docs: Rename our guide source files Rename the various "WSUG_" and "WSDG_" files to wsug_ and wsdg_ respectively. Remove the "chapter" and "app" parts from the filenames as well.
2023-01-29 21:54:05 +00:00
wsdg_src/wsdg_asn2wrs.adoc
wsdg_src/wsdg_build_intro.adoc
wsdg_src/wsdg_capture.adoc
wsdg_src/wsdg_dissection.adoc
wsdg_src/wsdg_env_intro.adoc
wsdg_src/wsdg_libraries.adoc
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
wsdg_src/wsdg_lua_support.adoc
wsdg_src/wsdg_preface.adoc
Docs: Rename our guide source files Rename the various "WSUG_" and "WSDG_" files to wsug_ and wsdg_ respectively. Remove the "chapter" and "app" parts from the filenames as well.
2023-01-29 21:54:05 +00:00
wsdg_src/wsdg_quick_setup.adoc
wsdg_src/wsdg_sources.adoc
wsdg_src/wsdg_tests.adoc
wsdg_src/wsdg_tools.adoc
wsdg_src/wsdg_userinterface.adoc
wsdg_src/wsdg_works.adoc
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}
Prepare for conversion of Guide chapters to AsciiDoc. svn path=/trunk/; revision=54936
2014-01-24 01:10:10 +00:00
)
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
set(WSDG_GRAPHICS
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
wsdg_src/images/caution.svg
wsdg_src/images/git-triangular-workflow.gv
wsdg_src/images/git-triangular-workflow.svg
wsdg_src/images/important.svg
wsdg_src/images/note.svg
wsdg_src/images/tip.svg
wsdg_src/images/warning.svg
wsdg_src/images/ws-capture_internals.dia
wsdg_src/images/ws-capture_internals.png
wsdg_src/images/ws-capture-sync.dia
wsdg_src/images/ws-capture-sync.png
wsdg_src/images/ws-capture-sync.png
wsdg_src/images/ws-function-blocks.dia
wsdg_src/images/ws-function-blocks.png
wsdg_src/images/ws-logo.png
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
)
set(WSUG_SOURCE
${WSUG_FILES}
${WSUG_GRAPHICS}
)
CMake: fix parallel build by not copying ws.css repeatedly A race condition exists with msbuild where building some targets (generate_{developer,user}-guide.xml, {developer,user}_guide_pdf) will result in parallel, repeated execution of the commands to copy 'ws.css'. Synchronize those executions using a single target to avoid this. Change-Id: Ie93d07e504bc18fa4e4e8aac5b611fba329ff188 Reviewed-on: https://code.wireshark.org/review/30553 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-09 11:08:01 +00:00
# Ensure ws.css is available when the user tries to open generated .html files.
cmake: do not remove ws.css; ignore auto-generated files Do not remove "ws.css" when doing a build in the source tree. Ignore files that were automatically generated with cmake and the Ninja generator (cmake -GNinja). Change-Id: I24cae27eb8ae9664e3354ba646fd5503649349b1 Reviewed-on: https://code.wireshark.org/review/12007 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2015-11-21 12:13:39 +00:00
if(NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
add_custom_command(
OUTPUT ws.css
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${CMAKE_CURRENT_SOURCE_DIR}/ws.css
${CMAKE_CURRENT_BINARY_DIR}/ws.css
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/ws.css
)
CMake: fix parallel build by not copying ws.css repeatedly A race condition exists with msbuild where building some targets (generate_{developer,user}-guide.xml, {developer,user}_guide_pdf) will result in parallel, repeated execution of the commands to copy 'ws.css'. Synchronize those executions using a single target to avoid this. Change-Id: Ie93d07e504bc18fa4e4e8aac5b611fba329ff188 Reviewed-on: https://code.wireshark.org/review/30553 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-09 11:08:01 +00:00
add_custom_target(copy_ws.css DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/ws.css)
else()
add_custom_target(copy_ws.css)
cmake: do not remove ws.css; ignore auto-generated files Do not remove "ws.css" when doing a build in the source tree. Ignore files that were automatically generated with cmake and the Ninja generator (cmake -GNinja). Change-Id: I24cae27eb8ae9664e3354ba646fd5503649349b1 Reviewed-on: https://code.wireshark.org/review/12007 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2015-11-21 12:13:39 +00:00
endif()
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
CMake: fix parallel build by not copying ws.css repeatedly A race condition exists with msbuild where building some targets (generate_{developer,user}-guide.xml, {developer,user}_guide_pdf) will result in parallel, repeated execution of the commands to copy 'ws.css'. Synchronize those executions using a single target to avoid this. Change-Id: Ie93d07e504bc18fa4e4e8aac5b611fba329ff188 Reviewed-on: https://code.wireshark.org/review/30553 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-09 11:08:01 +00:00
set( WSUG_BUILT_DEPS copy_ws.css)
Try to get CMake to build the Developer Guide again. I don't have dblatex installed so the release notes fail to build but the WSDG targets appear to work. svn path=/trunk/; revision=54952
2014-01-25 00:17:19 +00:00
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
set(WSDG_SOURCE
${WSDG_FILES}
${WSDG_GRAPHICS}
)
Lua: split up wslua files into class-based files The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-07-07 15:30:44 +00:00
# Note: file order here MATTERS!
# new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE
# files for the same module
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
set(WSLUA_MODULES
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dumper.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_field.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_gui.c
Adds support for Lua Int64 and UInt64 operators, functions, and general usefulness, working around bug #9162 until Lua 5.3 is released. The existing Int64 and UInt64 classes provide virtually no usefullness, other than for creating a string of their value. While one could then write Lua code to convert the string to Lua numbers and such, ultimately Lua has no native 64-bit integer support, making such a task difficult to handle in Lua. This change adds a host of functions and operators to the existing Int64 (gint64) and UInt64 (guint64) classes, to enable true 64-bit integer support on par with native Lua numbers. A test script is also provided, which tests the functions/operators. Change-Id: I4c5f8f5219b9a88198902283bd32ddf24c346bbe Reviewed-on: https://code.wireshark.org/review/83 Tested-by: Evan Huus <eapache@gmail.com> Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-03 03:49:30 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_int64.c
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c
Lua: split up wslua files into class-based files The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-07-07 15:30:44 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_address.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_column.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_nstime.c
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c
Lua: split up wslua files into class-based files The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-07-07 15:30:44 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dissector.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pref.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_expert.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_field.c
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c
Lua: split up wslua files into class-based files The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-07-07 15:30:44 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_byte_array.c
Add capture file reader/writer support for Lua so scripts can implement new capture file formats. This enables a Lua script to implement a brand new capture file format reader/writer, so that for example one could write a script to read from vendor-specific "logs" of packets, and show them as normal packets in wireshark. Change-Id: Id394edfffa94529f39789844c382b7ab6cc2d814 Reviewed-on: https://code.wireshark.org/review/431 Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com> Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-18 17:21:51 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file.c
Lua: split up wslua files into class-based files The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-07-07 15:30:44 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file_handler.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_frame_info.c
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_capture_info.c
Add various functions for Lua directory handling and path info This adds new functions to get plugins path info, find out if a directory exists, make a new one, remove one, etc. It also creates a file environment for user-supplied Lua scripts, to prevent global variable contamination as well as supply the script-specific file name. Some other minor cleanup was done as I found them. A new testsuite was added to test the existing and new directory functions. Change-Id: I19bd587b5e8a73d89b8521af73670e023314fb33 Reviewed-on: https://code.wireshark.org/review/832 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-26 06:24:51 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dir.c
wslua: expose some libwiretap APIs in Lua. Provide Lua version of wtap_file_type_subtype_string(), wtap_file_type_subtype_short_string(), and wtap_short_string_to_file_type_subtype(). This will be backported to the 3.2 and 3.4 branches, to allow scripts not run on the bleeding-edge version to use them.
2021-02-13 03:29:33 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_wtap.c
wslua: Rename wslua_util.c to wslua_utility.c. Rename wslua_util.c to wslua_utility.c so that our file name has the form "wslua_<lower case lua module name>.c", which is the case for our other modules.
2022-07-23 23:19:49 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_utility.c
Adds support for Lua struct library so one can pack/unpack binary structures This is based on Roberto Ierusalimschy's struct library, along with additional options based on Flemming Madsen's patch to the lua-users mailing list, and some changes I made to support 64-bit integer packing/unpacking. Details are in the top comments for wslua_struct.c. This also includes a test script. Change-Id: Ifcd0116ba013d5c760927721c8d6e9f28965534b Reviewed-on: https://code.wireshark.org/review/98 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-02-03 03:49:30 +00:00
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_struct.c
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00
)
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
# Empty file to trigger wsluarm generation.
ADD_CUSTOM_COMMAND(
OUTPUT
wsluarm
COMMAND ${CMAKE_COMMAND} -E make_directory wsluarm_src
docbook: Port make-wsluarm to Python3 Port the script that creates docbook/wsluarm_src/*.adoc to Python3. Ping #18152.
2022-06-30 01:33:36 +00:00
COMMAND ${PYTHON_EXECUTABLE}
${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.py
--output-directory wsluarm_src
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
${WSLUA_MODULES}
COMMAND ${CMAKE_COMMAND} -E touch
wsluarm
DEPENDS
docbook: Port make-wsluarm to Python3 Port the script that creates docbook/wsluarm_src/*.adoc to Python3. Ping #18152.
2022-06-30 01:33:36 +00:00
${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.py
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
${WSLUA_MODULES}
)
CMake: fix parallel build by not copying ws.css repeatedly A race condition exists with msbuild where building some targets (generate_{developer,user}-guide.xml, {developer,user}_guide_pdf) will result in parallel, repeated execution of the commands to copy 'ws.css'. Synchronize those executions using a single target to avoid this. Change-Id: Ie93d07e504bc18fa4e4e8aac5b611fba329ff188 Reviewed-on: https://code.wireshark.org/review/30553 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-11-09 11:08:01 +00:00
set( WSDG_BUILT_DEPS copy_ws.css wsluarm )
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
Fix release-notes.html generation The ASCIIDOC_CONF_FILES setting for asciidoc was only generated if any of the guides were being built. Clean up a dup setting and some and blank lines in FindASCIIDOC Change-Id: Ie8ab97db09e18cdb8d7e2a7bd4dcf8c288dd036f Reviewed-on: https://code.wireshark.org/review/19291 Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2016-12-15 19:54:01 +00:00
set( ASCIIDOC_CONF_FILES
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
attributes.adoc
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
# XXX Add macros
Fix release-notes.html generation The ASCIIDOC_CONF_FILES setting for asciidoc was only generated if any of the guides were being built. Clean up a dup setting and some and blank lines in FindASCIIDOC Change-Id: Ie8ab97db09e18cdb8d7e2a7bd4dcf8c288dd036f Reviewed-on: https://code.wireshark.org/review/19291 Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2016-12-15 19:54:01 +00:00
)
CMake: check Asciidoctor version availability before using it On Ubuntu trusty, Asciidoctor 1.4 is installed. This does not satisfy the minimum version requirement (1.5) and should not be used even if the binary is available. Change-Id: Iaffd55a5bcb26510b4b59f209768a61c3116d32f Fixes: v2.5.1rc0-76-g94a0f7c641 ("Switch from AsciiDoc to Asciidoctor.") Reviewed-on: https://code.wireshark.org/review/28576 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-03 09:42:20 +00:00
if(ASCIIDOCTOR_FOUND)
Generate DocBook conditionally. Add back a check when generating DocBook. Change-Id: I00679853d537f543db6f37a60ae4c46b3cce76e6 Reviewed-on: https://code.wireshark.org/review/9935 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 22:44:02 +00:00
# Generate the DocBook sources of user and developer guides
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
ASCIIDOCTOR2DOCBOOK(wsug_src/user-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
cmake: fix parallel docbook build Let targets depend on the generate_developer-guide.xml target instead of the developer-guide.xml output file. Change-Id: I66106ad69c9baedbd58a008b4dbbbf93b787c2c2 Reviewed-on: https://code.wireshark.org/review/14156 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2016-02-26 00:03:45 +00:00
add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml)
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
set_docbook_target_properties(user_guide_docbook)
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
ASCIIDOCTOR2DOCBOOK(wsdg_src/developer-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
cmake: fix parallel docbook build Let targets depend on the generate_developer-guide.xml target instead of the developer-guide.xml output file. Change-Id: I66106ad69c9baedbd58a008b4dbbbf93b787c2c2 Reviewed-on: https://code.wireshark.org/review/14156 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2016-02-26 00:03:45 +00:00
add_custom_target(developer_guide_docbook DEPENDS generate_developer-guide.xml)
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
set_docbook_target_properties(developer_guide_docbook)
Generate DocBook conditionally. Add back a check when generating DocBook. Change-Id: I00679853d537f543db6f37a60ae4c46b3cce76e6 Reviewed-on: https://code.wireshark.org/review/9935 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 22:44:02 +00:00
# Top-level guide targets.
add_custom_target(user_guides DEPENDS user_guide_docbook)
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
set_docbook_target_properties(user_guides)
Generate DocBook conditionally. Add back a check when generating DocBook. Change-Id: I00679853d537f543db6f37a60ae4c46b3cce76e6 Reviewed-on: https://code.wireshark.org/review/9935 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 22:44:02 +00:00
add_custom_target(developer_guides DEPENDS developer_guide_docbook)
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
set_docbook_target_properties(developer_guides)
Generate DocBook conditionally. Add back a check when generating DocBook. Change-Id: I00679853d537f543db6f37a60ae4c46b3cce76e6 Reviewed-on: https://code.wireshark.org/review/9935 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 22:44:02 +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
add_custom_target(all_guides DEPENDS user_guides developer_guides )
set_docbook_target_properties(all_guides)
Generate DocBook conditionally. Add back a check when generating DocBook. Change-Id: I00679853d537f543db6f37a60ae4c46b3cce76e6 Reviewed-on: https://code.wireshark.org/review/9935 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 22:44:02 +00:00
endif()
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
# User's Guide chain.
CMake: check Asciidoctor version availability before using it On Ubuntu trusty, Asciidoctor 1.4 is installed. This does not satisfy the minimum version requirement (1.5) and should not be used even if the binary is available. Change-Id: Iaffd55a5bcb26510b4b59f209768a61c3116d32f Fixes: v2.5.1rc0-76-g94a0f7c641 ("Switch from AsciiDoc to Asciidoctor.") Reviewed-on: https://code.wireshark.org/review/28576 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-03 09:42:20 +00:00
if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
XML2HTML(
user_guide
wsug
single-page
user-guide.xml
WSUG_GRAPHICS
)
XML2HTML(
user_guide
wsug
chunked
user-guide.xml
WSUG_GRAPHICS
)
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08:22 +00:00
add_custom_target(
user_guide_html
DEPENDS
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
wsug_html/index.html
wsug_html_chunked/index.html
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08: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
set_docbook_target_properties(user_guide_html)
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08:22 +00:00
add_dependencies(user_guides user_guide_html)
CMake: Install the HTML guides. Add a "FileInstall.cmake" module that installs files and directories. Use it to install the chunked HTML guides. Install the guides into CMAKE_INSTALL_FULL_DOCDIR. By default this is /usr/local/share/doc/Wireshark. Define DOC_DIR to match. Add explicit file and directory permissions to the default install targets. Remove the PDF install target. Bug: 14258 Change-Id: I4712a4047a54627b7520b5bf5f191e0761d19606 Reviewed-on: https://code.wireshark.org/review/25737 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-11 22:34:04 +00:00
list(APPEND GUIDE_INSTALL_DIRS ${CMAKE_CURRENT_BINARY_DIR}/wsug_html_chunked)
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
endif()
CMake: check Asciidoctor version availability before using it On Ubuntu trusty, Asciidoctor 1.4 is installed. This does not satisfy the minimum version requirement (1.5) and should not be used even if the binary is available. Change-Id: Iaffd55a5bcb26510b4b59f209768a61c3116d32f Fixes: v2.5.1rc0-76-g94a0f7c641 ("Switch from AsciiDoc to Asciidoctor.") Reviewed-on: https://code.wireshark.org/review/28576 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-03 09:42:20 +00:00
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
ASCIIDOCTOR2PDF(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08:22 +00:00
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
add_custom_target(
Docbook: Generate one PDF paper size. Generate a single PA4-sized PDF. PA4 is the approximate intersection of A4 and Letter[1]. This gives us one less file to build and distribute. If you're printing out hard copies of the guides this wastes a few pages compared to an A4-sized PDF, but if you're printing out hard copies of the guides you've already made a strong commitment to waste paper. Page counts: Guide Size Pages WSDG A4 203 WSDG Letter 217 WSDG PA4 217 WSUG A4 192 WSUG Letter 204 WSUG PA4 205 [1] https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4 Change-Id: If43d4b19947c77a51b3943a2b329dbab45025d79 Reviewed-on: https://code.wireshark.org/review/25438 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-23 19:02:16 +00:00
user_guide_pdf
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
DEPENDS
Docs: Give the PDF and EPUB guides descriptive filenames. Use the document title for our PDF and EPUB filenames under the theory that "Wireshark User’s Guide.pdf" is more obvious than "user-guide.pdf".
2021-08-03 20:42:20 +00:00
"${WSUG_TITLE}.pdf"
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +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
set_docbook_target_properties(user_guide_pdf)
Docbook: Generate one PDF paper size. Generate a single PA4-sized PDF. PA4 is the approximate intersection of A4 and Letter[1]. This gives us one less file to build and distribute. If you're printing out hard copies of the guides this wastes a few pages compared to an A4-sized PDF, but if you're printing out hard copies of the guides you've already made a strong commitment to waste paper. Page counts: Guide Size Pages WSDG A4 203 WSDG Letter 217 WSDG PA4 217 WSUG A4 192 WSUG Letter 204 WSUG PA4 205 [1] https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4 Change-Id: If43d4b19947c77a51b3943a2b329dbab45025d79 Reviewed-on: https://code.wireshark.org/review/25438 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-23 19:02:16 +00:00
add_dependencies(user_guides user_guide_pdf)
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
endif()
Docs: Add epub targets for the guides. Add user_guide_epub and developer_guide_epub targets that generate EPUB versions of the User's Guide and Developer's Guide. Ping #17494.
2021-07-28 17:23:50 +00:00
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE)
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
ASCIIDOCTOR2EPUB(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
Docs: Add epub targets for the guides. Add user_guide_epub and developer_guide_epub targets that generate EPUB versions of the User's Guide and Developer's Guide. Ping #17494.
2021-07-28 17:23:50 +00:00
add_custom_target(
user_guide_epub
DEPENDS
Docs: Give the PDF and EPUB guides descriptive filenames. Use the document title for our PDF and EPUB filenames under the theory that "Wireshark User’s Guide.pdf" is more obvious than "user-guide.pdf".
2021-08-03 20:42:20 +00:00
"${WSUG_TITLE}.epub"
Docs: Add epub targets for the guides. Add user_guide_epub and developer_guide_epub targets that generate EPUB versions of the User's Guide and Developer's Guide. Ping #17494.
2021-07-28 17:23:50 +00:00
)
set_docbook_target_properties(user_guide_epub)
add_dependencies(user_guides user_guide_epub)
endif()
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
# Developer's Guide chain.
CMake: check Asciidoctor version availability before using it On Ubuntu trusty, Asciidoctor 1.4 is installed. This does not satisfy the minimum version requirement (1.5) and should not be used even if the binary is available. Change-Id: Iaffd55a5bcb26510b4b59f209768a61c3116d32f Fixes: v2.5.1rc0-76-g94a0f7c641 ("Switch from AsciiDoc to Asciidoctor.") Reviewed-on: https://code.wireshark.org/review/28576 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-03 09:42:20 +00:00
if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
XML2HTML(
developer_guide
wsdg
single-page
developer-guide.xml
WSDG_GRAPHICS
)
XML2HTML(
developer_guide
wsdg
chunked
developer-guide.xml
WSDG_GRAPHICS
)
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08:22 +00:00
add_custom_target(
developer_guide_html
DEPENDS
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
wsdg_html/index.html
wsdg_html_chunked/index.html
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08: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
set_docbook_target_properties(developer_guide_html)
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08:22 +00:00
add_dependencies(developer_guides developer_guide_html)
CMake: Install the HTML guides. Add a "FileInstall.cmake" module that installs files and directories. Use it to install the chunked HTML guides. Install the guides into CMAKE_INSTALL_FULL_DOCDIR. By default this is /usr/local/share/doc/Wireshark. Define DOC_DIR to match. Add explicit file and directory permissions to the default install targets. Remove the PDF install target. Bug: 14258 Change-Id: I4712a4047a54627b7520b5bf5f191e0761d19606 Reviewed-on: https://code.wireshark.org/review/25737 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-11 22:34:04 +00:00
list(APPEND GUIDE_INSTALL_DIRS ${CMAKE_CURRENT_BINARY_DIR}/wsdg_html_chunked)
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
endif()
CMake: check Asciidoctor version availability before using it On Ubuntu trusty, Asciidoctor 1.4 is installed. This does not satisfy the minimum version requirement (1.5) and should not be used even if the binary is available. Change-Id: Iaffd55a5bcb26510b4b59f209768a61c3116d32f Fixes: v2.5.1rc0-76-g94a0f7c641 ("Switch from AsciiDoc to Asciidoctor.") Reviewed-on: https://code.wireshark.org/review/28576 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-03 09:42:20 +00:00
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
ASCIIDOCTOR2PDF(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
Rework CMake dependendencies in the docbook directory. Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07 22:08:22 +00:00
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
add_custom_target(
Docbook: Generate one PDF paper size. Generate a single PA4-sized PDF. PA4 is the approximate intersection of A4 and Letter[1]. This gives us one less file to build and distribute. If you're printing out hard copies of the guides this wastes a few pages compared to an A4-sized PDF, but if you're printing out hard copies of the guides you've already made a strong commitment to waste paper. Page counts: Guide Size Pages WSDG A4 203 WSDG Letter 217 WSDG PA4 217 WSUG A4 192 WSUG Letter 204 WSUG PA4 205 [1] https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4 Change-Id: If43d4b19947c77a51b3943a2b329dbab45025d79 Reviewed-on: https://code.wireshark.org/review/25438 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-23 19:02:16 +00:00
developer_guide_pdf
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +00:00
DEPENDS
Docs: Give the PDF and EPUB guides descriptive filenames. Use the document title for our PDF and EPUB filenames under the theory that "Wireshark User’s Guide.pdf" is more obvious than "user-guide.pdf".
2021-08-03 20:42:20 +00:00
"${WSDG_TITLE}.pdf"
CMake: Try to fix generated docbook dependencies. Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08 01:17:04 +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
set_docbook_target_properties(developer_guide_pdf)
Docbook: Generate one PDF paper size. Generate a single PA4-sized PDF. PA4 is the approximate intersection of A4 and Letter[1]. This gives us one less file to build and distribute. If you're printing out hard copies of the guides this wastes a few pages compared to an A4-sized PDF, but if you're printing out hard copies of the guides you've already made a strong commitment to waste paper. Page counts: Guide Size Pages WSDG A4 203 WSDG Letter 217 WSDG PA4 217 WSUG A4 192 WSUG Letter 204 WSUG PA4 205 [1] https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4 Change-Id: If43d4b19947c77a51b3943a2b329dbab45025d79 Reviewed-on: https://code.wireshark.org/review/25438 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-23 19:02:16 +00:00
add_dependencies(developer_guides developer_guide_pdf)
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
endif()
Docs: Add epub targets for the guides. Add user_guide_epub and developer_guide_epub targets that generate EPUB versions of the User's Guide and Developer's Guide. Ping #17494.
2021-07-28 17:23:50 +00:00
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE)
Docbook: Reorganize our guide directories Move the top-level user-guide.adoc and developer-guide.adoc to their respective source directores. This is in preparation for a future toolchain revamp. Move the wsug_graphics directory to wsug_src/images and wsdg_graphics directory to wsdg_src/images. Copy common_graphics/* to the each images directory and remove common_graphics. We only have five admonition graphics; duplicating them lets us remove some build config overhead. Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc. Remove a dummy file. Tested visually and by enabling `--failure-level=WARN`.
2023-02-11 00:11:20 +00:00
ASCIIDOCTOR2EPUB(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
Docs: Add epub targets for the guides. Add user_guide_epub and developer_guide_epub targets that generate EPUB versions of the User's Guide and Developer's Guide. Ping #17494.
2021-07-28 17:23:50 +00:00
add_custom_target(
developer_guide_epub
DEPENDS
Docs: Give the PDF and EPUB guides descriptive filenames. Use the document title for our PDF and EPUB filenames under the theory that "Wireshark User’s Guide.pdf" is more obvious than "user-guide.pdf".
2021-08-03 20:42:20 +00:00
"${WSDG_TITLE}.epub"
Docs: Add epub targets for the guides. Add user_guide_epub and developer_guide_epub targets that generate EPUB versions of the User's Guide and Developer's Guide. Ping #17494.
2021-07-28 17:23:50 +00:00
)
set_docbook_target_properties(developer_guide_epub)
add_dependencies(developer_guides developer_guide_epub)
endif()
CMake: Install the HTML guides. Add a "FileInstall.cmake" module that installs files and directories. Use it to install the chunked HTML guides. Install the guides into CMAKE_INSTALL_FULL_DOCDIR. By default this is /usr/local/share/doc/Wireshark. Define DOC_DIR to match. Add explicit file and directory permissions to the default install targets. Remove the PDF install target. Bug: 14258 Change-Id: I4712a4047a54627b7520b5bf5f191e0761d19606 Reviewed-on: https://code.wireshark.org/review/25737 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-11 22:34:04 +00:00
if (GUIDE_INSTALL_DIRS)
# The installation location and DOC_DIR in ui/help_url.c must
# match.
add_custom_target(install_guides
COMMAND ${CMAKE_COMMAND} -P
${CMAKE_SOURCE_DIR}/cmake/modules/FileInstall.cmake
${GUIDE_INSTALL_DIRS}
${CMAKE_INSTALL_FULL_DOCDIR}
DEPENDS
user_guide_html developer_guide_html
)
set_docbook_target_properties(install_guides)
endif()
Docbook: Generate one PDF paper size. Generate a single PA4-sized PDF. PA4 is the approximate intersection of A4 and Letter[1]. This gives us one less file to build and distribute. If you're printing out hard copies of the guides this wastes a few pages compared to an A4-sized PDF, but if you're printing out hard copies of the guides you've already made a strong commitment to waste paper. Page counts: Guide Size Pages WSDG A4 203 WSDG Letter 217 WSDG PA4 217 WSUG A4 192 WSUG Letter 204 WSUG PA4 205 [1] https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4 Change-Id: If43d4b19947c77a51b3943a2b329dbab45025d79 Reviewed-on: https://code.wireshark.org/review/25438 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-23 19:02:16 +00:00
# release_notes: release-notes.html release-notes.txt
- Beginnings of cmake in docbook directory - Add note about "make help" - Move beginnings of packaging into its own file: CPackConfig.txt svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +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
add_custom_target( release_notes_html DEPENDS release-notes.html )
set_docbook_target_properties(release_notes_html)
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
add_custom_target( release_notes_txt DEPENDS release-notes.txt )
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
set_docbook_target_properties(release_notes_txt)
Add generation of release notes. Regenerate NEWS file svn path=/trunk/; revision=53014
2013-11-01 09:55:26 +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
# Force serial execution so that separate asciidoctor instances don't
# trip on each other
# add_dependencies ( release_notes_txt release_notes_html )
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
add_custom_target( 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
set_docbook_target_properties(release_notes)
CMake: Make it easier to generate the release notes & NEWS. Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11 00:50:56 +00:00
add_dependencies ( release_notes release_notes_txt release_notes_html )
add_custom_target(
news
COMMAND ${CMAKE_COMMAND} -E copy_if_different
Add generation of release notes. Regenerate NEWS file svn path=/trunk/; revision=53014
2013-11-01 09:55:26 +00:00
${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
${CMAKE_SOURCE_DIR}/NEWS
DEPENDS
cmake: do not remove ws.css; ignore auto-generated files Do not remove "ws.css" when doing a build in the source tree. Ignore files that were automatically generated with cmake and the Ninja generator (cmake -GNinja). Change-Id: I24cae27eb8ae9664e3354ba646fd5503649349b1 Reviewed-on: https://code.wireshark.org/review/12007 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2015-11-21 12:13:39 +00:00
${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
Add generation of release notes. Regenerate NEWS file svn path=/trunk/; revision=53014
2013-11-01 09:55:26 +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
set_docbook_target_properties(news)
Add generation of release notes. Regenerate NEWS file svn path=/trunk/; revision=53014
2013-11-01 09:55:26 +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( ASCIIDOCTOR_FOUND )
Docs: Use Asciidoctor to copy ws.css. Use the `copycss` attribute in the release notes and FAQ to copy ws.css to the right location.
2021-10-11 21:36:58 +00:00
ASCIIDOCTOR2HTML( release-notes.adoc )
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
ASCIIDOCTOR2TXT( release-notes.adoc )
CMake: Fix package requirements for building docs Make ASCIIDOC and XSLTPROC packages required if building any of the HTML, PDF or CHM guides. Don't attempt to build the release notes if ASCIIDOC isn't found. Change-Id: Id61653a635f91cbaffa32fb26ddbdbc568b74528 Reviewed-on: https://code.wireshark.org/review/24483 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Petri-Dish: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Petri Dish Buildbot Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-11-18 21:53:46 +00:00
endif()
Add generation of release notes. Regenerate NEWS file svn path=/trunk/; revision=53014
2013-11-01 09:55:26 +00:00
Convert the FAQ to Asciidoctor and remove old help files. Convert our self-generating FAQ to Asciidoctor via the following steps: - `help/faq.py > /tmp/faq.html`. - `pandoc -t asciidoc -o docbook/faq.adoc /tmp/faq.html`. - Manually clean up the markup using a text editor. Question and answer content was left intact. Removing or updating obsolete content will have to be done in a separate change. The Asciidoctor project uses the .adoc extension, so start using it here as well. The contents of the "help" directory appear to have been used for offline support in help_url.c, but that functionality was removed in 2008 in 242e3b78bc. Its content is covered in the User's Guide and man pages so remove it. Change-Id: I9060eefe97cfc137f8b414077c30f814379b576a Reviewed-on: https://code.wireshark.org/review/32014 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-02-11 22:24:18 +00:00
# FAQ
add_custom_target( faq_html DEPENDS faq.html )
set_docbook_target_properties(faq_html)
add_custom_target( faq )
set_docbook_target_properties(faq)
add_dependencies ( faq faq_html )
if( ASCIIDOCTOR_FOUND )
Docs: Use Asciidoctor to copy ws.css. Use the `copycss` attribute in the release notes and FAQ to copy ws.css to the right location.
2021-10-11 21:36:58 +00:00
ASCIIDOCTOR2HTML( faq.adoc )
Convert the FAQ to Asciidoctor and remove old help files. Convert our self-generating FAQ to Asciidoctor via the following steps: - `help/faq.py > /tmp/faq.html`. - `pandoc -t asciidoc -o docbook/faq.adoc /tmp/faq.html`. - Manually clean up the markup using a text editor. Question and answer content was left intact. Removing or updating obsolete content will have to be done in a separate change. The Asciidoctor project uses the .adoc extension, so start using it here as well. The contents of the "help" directory appear to have been used for offline support in help_url.c, but that functionality was removed in 2008 in 242e3b78bc. Its content is covered in the User's Guide and man pages so remove it. Change-Id: I9060eefe97cfc137f8b414077c30f814379b576a Reviewed-on: https://code.wireshark.org/review/32014 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-02-11 22:24:18 +00:00
endif()
cmake: fix missing docbook dependency Running "ninja developer_guide_html" somehow did not produce a new HTML docbook once wsluarm.ascii (a dependency of developer-guide.xml) was modified. It turns out that output file docbook/wsdg_html/index.html only had a ordering-only dependency on target generate_developer-guide.xml. An extra dependency is needed on the output file to ensure that the HTML file gets rebuild on changes. See the last note on https://samthursfield.wordpress.com/2015/11/21/cmake-dependencies-between-targets-and-files-and-custom-commands/ Fixes v2.1.0rc0-2137-gd544ecd ("cmake: fix parallel docbook build"). Change-Id: I7689c71994f13b29cf7f8561f7c993aa8298632d Reviewed-on: https://code.wireshark.org/review/18225 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2016-10-16 22:35:50 +00:00
#
HTTPS (almost) everywhere. Change all wireshark.org URLs to use https. Fix some broken links while we're at it. Change-Id: I161bf8eeca43b8027605acea666032da86f5ea1c Reviewed-on: https://code.wireshark.org/review/34089 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-07-26 18:43:17 +00:00
# Editor modelines - https://www.wireshark.org/tools/modelines.html
cmake: fix missing docbook dependency Running "ninja developer_guide_html" somehow did not produce a new HTML docbook once wsluarm.ascii (a dependency of developer-guide.xml) was modified. It turns out that output file docbook/wsdg_html/index.html only had a ordering-only dependency on target generate_developer-guide.xml. An extra dependency is needed on the output file to ensure that the HTML file gets rebuild on changes. See the last note on https://samthursfield.wordpress.com/2015/11/21/cmake-dependencies-between-targets-and-files-and-custom-commands/ Fixes v2.1.0rc0-2137-gd544ecd ("cmake: fix parallel docbook build"). Change-Id: I7689c71994f13b29cf7f8561f7c993aa8298632d Reviewed-on: https://code.wireshark.org/review/18225 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2016-10-16 22:35:50 +00:00
#
# Local variables:
# c-basic-offset: 8
# tab-width: 8
# indent-tabs-mode: t
# End:
#
# vi: set shiftwidth=8 tabstop=8 noexpandtab:
# :indentSize=8:tabSize=8:noTabs=false:
#