Wireshark-dev: Re: [Wireshark-dev] Building Wireshark 3.4.0 documentation on Windows
Date Index · Thread Index · Other Months · All Mailing Lists
Date Prev · Date Next · Thread Prev · Thread Next
From: "Maynard, Chris" <Christopher.Maynard@xxxxxxx>
Date: Sat, 31 Oct 2020 18:49:31 +0000

And maybe CMakeLists.txt[1][2] should be updated to "find_package( Asciidoctor 2.3 ) " from "find_package( Asciidoctor 1.5 )”?

- Chris

[1]: https://gitlab.com/wireshark/wireshark/-/blob/master/CMakeLists.txt#L1214

[2]: https://gitlab.com/wireshark/wireshark/-/blob/release-3.4/CMakeLists.txt#L1214

 

From: Wireshark-dev <wireshark-dev-bounces@xxxxxxxxxxxxx> On Behalf Of Maynard, Chris via Wireshark-dev
Sent: Saturday, October 31, 2020 2:42 PM
To: wireshark-dev@xxxxxxxxxxxxx
Cc: Maynard, Chris <Christopher.Maynard@xxxxxxx>
Subject: [Wireshark-dev] Building Wireshark 3.4.0 documentation on Windows

 

Section 2.2.8 of the Wireshark Developer’s Guide[1] instructs you to install asciidoctor, xsltproc and docbook if you want to build the Wireshark documentation; however, it doesn’t specify the minimum version requirements of those tools.

 

Attempting to build the documentation for the new 3.4.0 release failed on my system.  Running "choco list --localonly" showed that I had these relevant package versions installed:

 

asciidoctorj 2.1.0

docbook-bundle 1.0.0

xsltproc 1.1.28.0

 

… and running "choco outdated" revealed that asciidoctor was outdated:

 

Chocolatey v0.10.15

Outdated Packages

Output is package name | current version | available version | pinned?

 

asciidoctorj|2.1.0|2.3.0|false

 

I updated the asciidoctor package to version 2.3.0 and was able to successfully build the documentation.  (NOTE: I actually ran "choco upgrade all" to upgrade all packages.)  In any case, if building the documentation fails for you, you may want to check your installed versions and upgrade to the latest available packages if any are outdated.

 

And perhaps the Developer’s Guide should mention minimum required versions, if possible?

- Chris

 

 

CONFIDENTIALITY NOTICE: This message is the property of International Game Technology PLC and/or its subsidiaries and may contain proprietary, confidential or trade secret information. This message is intended solely for the use of the addressee. If you are not the intended recipient and have received this message in error, please delete this message from your system. Any unauthorized reading, distribution, copying, or other use of this message or its attachments is strictly prohibited.