Wireshark-commits: [Wireshark-commits] master 94a0f7c: Switch from AsciiDoc to Asciidoctor.
Date Index · Thread Index · Other Months · All Mailing Lists
Date Prev · Date Next · Thread Prev · Thread Next
From: Wireshark code review <code-review-do-not-reply@xxxxxxxxxxxxx>
Date: Sun, 11 Feb 2018 18:22:18 +0000
URL: https://code.wireshark.org/review/gitweb?p=wireshark.git;a=commit;h=94a0f7c6414cb83535e89557ce3cce47a1808fec
Submitter: Gerald Combs (gerald@xxxxxxxxxxxxx)
Changed: branch: master
Repository: wireshark

Commits:

94a0f7c by Gerald Combs (gerald@xxxxxxxxxxxxx):

    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@xxxxxxxxxxxxx>
    Tested-by: Petri Dish Buildbot
    Reviewed-by: Gerald Combs <gerald@xxxxxxxxxxxxx>
    

Actions performed:

    from  5a674d0   wslua: Convert more comment markup to Asciidoctor.
    adds  94a0f7c   Switch from AsciiDoc to Asciidoctor.


Summary of changes:
 CMakeLists.txt                                     |   7 +-
 CMakeOptions.txt                                   |   5 -
 Makefile.am                                        |   1 -
 cmake/modules/FindASCIIDOC.cmake                   | 262 --------------
 cmake/modules/FindAsciidoctor.cmake                | 146 ++++++++
 cmake/modules/FindFOP.cmake                        |  37 --
 cmake/modules/FindLYNX.cmake                       |   8 +-
 cmake/modules/FindXSLTPROC.cmake                   |  62 +---
 configure.ac                                       |  30 +-
 debian/control                                     |   2 +-
 debian/rules                                       |   3 +-
 docbook/CMakeLists.txt                             | 124 +++----
 docbook/Makefile.am                                | 147 ++++----
 docbook/{README.txt => README.adoc}                | 219 +++++------
 docbook/asciidoctor-asciidoc.conf                  | 401 ---------------------
 docbook/asciidoctor-macros/README.adoc             |   5 +
 docbook/asciidoctor-macros/commaize-block.rb       |   6 +
 .../asciidoctor-macros/commaize-block/extension.rb |  46 +++
 .../asciidoctor-macros/commaize-block/sample.adoc  |  31 ++
 .../asciidoctor-macros/cve_idlink-inline-macro.rb  |   8 +
 .../cve_idlink-inline-macro/extension.rb           |  31 ++
 .../asciidoctor-macros/ws_buglink-inline-macro.rb  |   8 +
 .../ws_buglink-inline-macro/extension.rb           |  36 ++
 .../asciidoctor-macros/ws_salink-inline-macro.rb   |   8 +
 .../ws_salink-inline-macro/extension.rb            |  30 ++
 docbook/attributes.asciidoc                        |   6 +
 docbook/custom_layer_pdf.xsl                       |  89 -----
 docbook/custom_layer_single_html.xsl               |  16 +
 docbook/release-notes.asciidoc                     |  21 +-
 docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc |  22 +-
 docbook/wsdg_src/WSDG_chapter_tools.asciidoc       |   2 -
 packaging/nsis/CMakeLists.txt                      |   2 +-
 tools/Makefile.am                                  |   1 -
 tools/checklicenses.py                             |   4 +-
 tools/runa2x.sh                                    |  53 ---
 35 files changed, 664 insertions(+), 1215 deletions(-)
 delete mode 100644 cmake/modules/FindASCIIDOC.cmake
 create mode 100644 cmake/modules/FindAsciidoctor.cmake
 delete mode 100644 cmake/modules/FindFOP.cmake
 rename docbook/{README.txt => README.adoc} (57%)
 delete mode 100644 docbook/asciidoctor-asciidoc.conf
 create mode 100644 docbook/asciidoctor-macros/README.adoc
 create mode 100644 docbook/asciidoctor-macros/commaize-block.rb
 create mode 100644 docbook/asciidoctor-macros/commaize-block/extension.rb
 create mode 100644 docbook/asciidoctor-macros/commaize-block/sample.adoc
 create mode 100644 docbook/asciidoctor-macros/cve_idlink-inline-macro.rb
 create mode 100644 docbook/asciidoctor-macros/cve_idlink-inline-macro/extension.rb
 create mode 100644 docbook/asciidoctor-macros/ws_buglink-inline-macro.rb
 create mode 100644 docbook/asciidoctor-macros/ws_buglink-inline-macro/extension.rb
 create mode 100644 docbook/asciidoctor-macros/ws_salink-inline-macro.rb
 create mode 100644 docbook/asciidoctor-macros/ws_salink-inline-macro/extension.rb
 delete mode 100644 docbook/custom_layer_pdf.xsl
 create mode 100644 docbook/custom_layer_single_html.xsl
 delete mode 100755 tools/runa2x.sh