diff options
| author | Gerald Combs <gerald@wireshark.org> | 2017-10-19 15:03:55 -0700 |
|---|---|---|
| committer | Gerald Combs <gerald@wireshark.org> | 2018-02-11 18:22:09 +0000 |
| commit | 94a0f7c6414cb83535e89557ce3cce47a1808fec (patch) | |
| tree | c6e6f18ed0e324bed987ac2873571ffa9e6e7d74 /CMakeOptions.txt | |
| parent | 5a674d05c900be0007b71d11ff52e7f972359b5d (diff) | |
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>
Diffstat (limited to 'CMakeOptions.txt')
| -rw-r--r-- | CMakeOptions.txt | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/CMakeOptions.txt b/CMakeOptions.txt index 6b53442f9a..c011f3e65b 100644 --- a/CMakeOptions.txt +++ b/CMakeOptions.txt @@ -57,11 +57,6 @@ endif() option(ENABLE_STATIC "Build Wireshark libraries statically" OFF) option(ENABLE_PLUGINS "Build with plugins" ON) option(ENABLE_PLUGIN_IFDEMO "Build with plugin interface demo" OFF) -option(ENABLE_HTML_GUIDES "Build HTML User & Developer Guides" OFF) -option(ENABLE_PDF_GUIDES "Build PDF User & Developer Guides" OFF) -if(WIN32) - option(ENABLE_CHM_GUIDES "Build HTML Help User & Developer Guides" OFF) -endif() option(ENABLE_PCAP_NG_DEFAULT "Enable pcapng as default file format" ON) option(ENABLE_PORTAUDIO "Build with PortAudio support" ON) |