aboutsummaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2017-10-19 15:03:55 -0700
committerGerald Combs <gerald@wireshark.org>2018-02-11 18:22:09 +0000
commit94a0f7c6414cb83535e89557ce3cce47a1808fec (patch)
treec6e6f18ed0e324bed987ac2873571ffa9e6e7d74 /tools
parent5a674d05c900be0007b71d11ff52e7f972359b5d (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 'tools')
-rw-r--r--tools/Makefile.am1
-rwxr-xr-xtools/checklicenses.py4
-rwxr-xr-xtools/runa2x.sh53
3 files changed, 2 insertions, 56 deletions
diff --git a/tools/Makefile.am b/tools/Makefile.am
index 5a194c75d8..2bcb22722e 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -83,7 +83,6 @@ EXTRA_DIST = \
randpkt-test.sh \
rdps.py \
rpm_setup.sh \
- runa2x.sh \
test-common.sh \
test-captures.sh \
textify.ps1 \
diff --git a/tools/checklicenses.py b/tools/checklicenses.py
index f7ed3043d0..ae370dc721 100755
--- a/tools/checklicenses.py
+++ b/tools/checklicenses.py
@@ -95,10 +95,10 @@ PATH_SPECIFIC_WHITELISTED_LICENSES = {
'doc/': [
'UNKNOWN',
],
- 'docbook/custom_layer_pdf.xsl': [
+ 'docbook/custom_layer_chm.xsl': [
'UNKNOWN',
],
- 'docbook/custom_layer_chm.xsl': [
+ 'docbook/custom_layer_single_html.xsl': [
'UNKNOWN',
],
'docbook/ws.css' : [
diff --git a/tools/runa2x.sh b/tools/runa2x.sh
deleted file mode 100755
index 1c234f49ab..0000000000
--- a/tools/runa2x.sh
+++ /dev/null
@@ -1,53 +0,0 @@
-#!/bin/sh -xv
-
-#
-# runa2x.sh
-# Wrapper script for running Cygwin's a2x via CMake.
-#
-# Wireshark - Network traffic analyzer
-# By Gerald Combs <gerald@wireshark.org>
-# Copyright 2015 Gerald Combs
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-#
-
-# Bugs:
-# - This script shouldn't exist. Unfortunately there doesn't appear
-# to be a way to construct a Windows command line that can set the
-# environment variables below, then run /usr/bin/a2x (which is a symlink).
-
-# Ensure cygwin bin dir is on the path if running under it
-if [[ $OSTYPE == "cygwin" ]]; then
- PATH="$PATH:/usr/bin"
-else
- >&2 echo "We're trying to limit the scope of this insanity to CMake + Cygwin"
- exit 1
-fi
-
-LC_ALL=C
-export LC_ALL
-
-TZ=UTC
-export TZ
-
-PATH=/usr/bin
-export PATH
-
-PYTHONHOME=/
-export PYTHONHOME
-
-echo "running a2x with args $@"
-
-a2x "$@"