osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

CMake+docs: Use Asciidoctor.js if it's available. 

Add the executables shipped by the Asciidoctor.js project to
FindAsciidoctor.cmake, and update the Developer's Guide to match.
This commit is contained in:
Gerald Combs 2021-06-22 14:42:09 -07:00 committed by Wireshark GitLab Utility
parent 701d0565c5
commit cdd6f2ec80
3 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cmake/modules/FindAsciidoctor.cmake
View File

@ -11,6 +11,10 @@ FIND_PROGRAM(ASCIIDOCTOR_EXECUTABLE
asciidoctorj
asciidoctor
asciidoctor.ruby2.1
# Asciidoctor.js releases
asciidoctor-linux
asciidoctor-macos
asciidoctor-win
PATHS
/bin
/usr/bin

2
docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
View File

@ -345,7 +345,7 @@ Chocolatey ensures cmake.exe is on your path.
==== Install Asciidoctor, Xsltproc, And DocBook
https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby script or via a Java wrapper (AsciidoctorJ).
https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby script or via a Java wrapper (AsciidoctorJ) or JavaScript (Asciidoctor.js).
It is used in conjunction with Xsltproc and DocBook to generate the documentation you're reading and the User’s Guide.
You can install AsciidoctorJ, Xsltproc, and DocBook using Chocolatey.

11
docbook/wsdg_src/WSDG_chapter_tools.adoc
View File

@ -472,18 +472,15 @@ Release notes text:: Asciidoctor → _HTML_ → html2text.py
==== Asciidoctor
https://asciidoctor.org/[Asciidoctor] comes in several flavors: a Ruby
gem (Asciidoctor), a Java bundle (AsciidoctorJ), and transpiled
JavaScript (Asciidoctor.js). Only the Asciidoctor and AsciidoctorJ
flavors are supported for building the Wireshark documentation and
AsciidoctorJ is recommended.
https://asciidoctor.org/[Asciidoctor] comes in several flavors: a Ruby gem (Asciidoctor), a Java bundle (AsciidoctorJ), and transpiled JavaScript (Asciidoctor.js).
Any of them can be used to build Wireshark’s documentation.
The guides and release notes were originally written in DocBook (hence the directory name).
They were later converted to AsciiDoc and then migrated to Asciidoctor.
We currently use Asciidoctor’s modern (>= 1.5.0) syntax.
PDF output requires Asciidoctor PDF. It is included with AsciidoctorJ
but _not_ with Asciidoctor.
PDF output requires Asciidoctor’s PDF backend.
It is included with AsciidoctorJ and Asciidoctor.js but _not_ with Asciidoctor.
==== DocBook XML and XSL