On 11/1/20 2:29 PM, Graham Bloice wrote:
>
> On Sat, 31 Oct 2020 at 18:42, Maynard, Chris via Wireshark-dev
> <[email protected] <mailto:[email protected]>> wrote:
>
> 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?
>
>
> I'm not sure about doing this, it's a never ending chase.
>
> I do agree that the CMake generation step could check minimum requirements.
It does:
find_package( Asciidoctor 1.5 )
1.5.0 (released in 2014) and later support the "modern" syntax described at
https://asciidoctor.org/docs/migration/), which is what we currently use in our
documentation. I can successfully build the user_guides, developer_guides, and
release_notes targets here on an Ubuntu system with AsciiDoctor 1.5.5
installed. Chris, do you remember what error(s) you ran into with AsciiDoctorJ
2.1.0?
___________________________________________________________________________
Sent via: Wireshark-dev mailing list <[email protected]>
Archives: https://www.wireshark.org/lists/wireshark-dev
Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-dev
mailto:[email protected]?subject=unsubscribe
