On Mon, 2 Nov 2020 at 15:06, Maynard, Chris via Wireshark-dev < wireshark-dev@wireshark.org> wrote:
> > -----Original Message----- > > From: Wireshark-dev <wireshark-dev-boun...@wireshark.org> On Behalf Of > > Gerald Combs > > Sent: Sunday, November 1, 2020 8:36 PM > > To: Developer support list for Wireshark <wireshark-dev@wireshark.org>; > > Graham Bloice <graham.blo...@trihedral.com> > > Subject: Re: [Wireshark-dev] Building Wireshark 3.4.0 documentation on > > Windows > > > > On 11/1/20 2:29 PM, Graham Bloice wrote: > > > > > > On Sat, 31 Oct 2020 at 18:42, Maynard, Chris via Wireshark-dev > <wireshark- > > d...@wireshark.org <mailto:wireshark-dev@wireshark.org>> 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? > > Unfortunately, I don't have the exact error, but IIRC, it was some > non-intuitive, rather generic "Error 1" output or something. > > So perhaps it wasn't the asciidoctor upgrade that resolved the problem. > As I mentioned, some other packages were upgraded as well. > > Here's the list of packages and versions installed before the upgrade: > choco list --localonly > Chocolatey v0.10.15 > apache-fop 2.2 > asciidoctorj 2.1.0 > autohotkey.portable 1.1.32.00 > chocolatey 0.10.15 > chocolatey-core.extension 1.3.5.1 > docbook-bundle 1.0.0 > easy.install 0.6.11.4 > html-help-workshop 1.32 > jre8 8.0.231 > pip 1.2.0 > python 3.7.5 > python3 3.7.5 > speex 1.0.4 > strawberryperl 5.30.1.1 > windbg 10.0.10586.15 > winflexbison 2.4.9.20170215 > xsltproc 1.1.28.0 > 17 packages installed. > > And here are those that were determined to be outdated: > choco outdated > Chocolatey v0.10.15 > Outdated Packages > Output is package name | current version | available version | pinned? > > apache-fop|2.2|2.4|false > asciidoctorj|2.1.0|2.3.0|false > autohotkey.portable|1.1.32.00|1.1.33.02|false > easy.install|0.6.11.4|0.6.11.4|false > jre8|8.0.231|8.0.271|false > python|3.7.5|3.9.0|false > python3|3.7.5|3.9.0|false > strawberryperl|5.30.1.1|5.32.0.1|false > > Chocolatey has determined 7 package(s) are outdated. > 1 package(s) had warnings. > Warnings: > - easy.install > > And here's the list of packages and versions after the upgrade (Note: > strawberryperl failed to update): > choco list --localonly > Chocolatey v0.10.15 > apache-fop 2.4 > asciidoctorj 2.3.0 > autohotkey.portable 1.1.33.02 > chocolatey-core.extension 1.3.5.1 > chocolatey-windowsupdate.extension 1.0.2 > docbook-bundle 1.0.0 > easy.install 0.6.11.4 > html-help-workshop 1.32 > jre8 8.0.271 > KB2919355 1.0.20160915 > KB2919442 1.0.20160915 > KB2999226 1.0.20181019 > KB3033929 1.0.3 > KB3035131 1.0.1 > pip 1.2.0 > python 3.9.0 > python3 3.9.0 > speex 1.0.4 > strawberryperl 5.30.1.1 > vcredist140 14.27.29112 > vcredist2015 14.0.24215.20170201 > windbg 10.0.10586.15 > winflexbison 2.4.9.20170215 > xsltproc 1.1.28.0 > 24 packages installed. > > FWIW, Strawberry Perl has failed to update for me with chocolatey the last few versions, my workaround is to uninstall and then install again. There is a winflexbison3 package that has newer versions, and both nsis and wixtoolset are available as chocolatey packages. I don't think apache-fop or xsltproc are required now (I don't have them in my current VM's) and I've never installed speex. -- Graham Bloice
___________________________________________________________________________ Sent via: Wireshark-dev mailing list <wireshark-dev@wireshark.org> Archives: https://www.wireshark.org/lists/wireshark-dev Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-dev mailto:wireshark-dev-requ...@wireshark.org?subject=unsubscribe
