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 /docbook/wsdg_src | |
| 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 'docbook/wsdg_src')
| -rw-r--r-- | docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc | 22 | ||||
| -rw-r--r-- | docbook/wsdg_src/WSDG_chapter_tools.asciidoc | 2 |
2 files changed, 17 insertions, 7 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc index b8d9674e22..e562713016 100644 --- a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc @@ -150,8 +150,6 @@ so it shows a version number for: * Web/wget (not needed if using CMake) -* Text/asciidoc - * Text/docbook-xml45 // Also need: bash/sh, sed @@ -173,14 +171,14 @@ Alternatively you can install Cygwin and its packages using Chocolatey: PS$>choco install cygwin PS$>choco install cyg-get ---- -//PS$>choco install sed asciidoc [...] -source cygwin +//PS$>choco install sed [...] -source cygwin Chocolatey installs Cygwin in _C:\tools\cygwin_ by default. You can directly download packages via `cyg-get` ---- -PS$>cyg-get asciidoc patch docbook-xml45 [...] +PS$>cyg-get docbook-xml45 [...] ---- You can use Chocolatey’s Win flex-bison packages rather than the Cygwin @@ -281,6 +279,20 @@ PS$>choco install cmake.portable Chocolatey ensures cmake.exe is on your path. +[[ChSetupAsciidoctor]] + +==== Install Asciidoctor + +http://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby +script or via a Java wrapper (AsciidoctorJ). The easiest way to install +it on Windows is via Chocolatey: + +---- +PS$>choco install asciidoctorj +---- + +Chocolatey ensures that asciidoctorj.exe is on your path. + ==== Install and Prepare Sources [TIP] @@ -422,7 +434,7 @@ If you've closed the Visual Studio Command Prompt <<ChSetupPrepareCommandCom,pre To generate the build files enter the following at the Visual Studio command prompt: ---- -> cmake -DENABLE_CHM_GUIDES=on -G "Visual Studio 14 2015" ..\wireshark +> cmake -G "Visual Studio 14 2015" ..\wireshark ---- Adjusting the paths as required to Python and the wireshark source tree. diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc index 41227ba133..f3b0d0145c 100644 --- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc @@ -231,8 +231,6 @@ using the `-D` flag. Useful variables and generators include the following: -DENABLE_GTK3=ON:: Enable GTK+ 3 --DENABLE_HTML_GUIDES=ON -DENABLE_PDF_GUIDES=ON:: Build documentation - +++-DCMAKE_C_FLAGS='-Qunused-arguments'+++:: Make ccache and clang work together -DPYTHON_EXECUTABLE=c:/Python27/python:: Force the Python path. Useful on Windows since Cygwin’s /usrbin/python is a symlink. |