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/release-notes.asciidoc | |
| 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/release-notes.asciidoc')
| -rw-r--r-- | docbook/release-notes.asciidoc | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/docbook/release-notes.asciidoc b/docbook/release-notes.asciidoc index d6f04a53c3..7e1ddfabb5 100644 --- a/docbook/release-notes.asciidoc +++ b/docbook/release-notes.asciidoc @@ -22,9 +22,9 @@ Features section below for more details. //The following bugs have been fixed: -//* ws-buglink:5000[] -//* ws-buglink:6000[Wireshark bug] -//* cve-idlink:2014-2486[] +//* ws_buglink:5000[] +//* ws_buglink:6000[Wireshark bug] +//* cve_idlink:2014-2486[] //* Wireshark convinced you to switch seats on the plane while neglecting to tell you that its seat was noticeably moist. //_Non-empty section placeholder._ @@ -75,8 +75,9 @@ since version 2.4.0: === New Protocol Support -// Add one protocol per line between the --sort-and-group-- delimiters. ---sort-and-group-- +// Add one protocol per line between the -- delimiters. +[commaize] +-- ActiveMQ Artemis Core Protocol AMT (Automatic Multicast Tunneling) Bluetooth Mesh @@ -104,7 +105,7 @@ Tibia TWAMP and OWAMP Wi-Fi Device Provisioning Protocol 802.11ax (High Efficiency WLAN (HEW)) ---sort-and-group-- +-- === Updated Protocol Support @@ -114,16 +115,16 @@ Too many protocols have been updated to list here. //_Non-empty section placeholder._ // Add one file type per line between the --sort-and-group-- delimiters. ---sort-and-group-- +[commaize] Microsoft Network Monitor ---sort-and-group-- === New and Updated Capture Interfaces support //_Non-empty section placeholder._ ---sort-and-group-- +[commaize] +-- LoRaTap ---sort-and-group-- +-- //=== Major API Changes |