[prev in list] [next in list] [prev in thread] [next in thread] 

List:       wireshark-dev
Subject:    Re: [Wireshark-dev] Building Wireshark 3.4.0 documentation on Windows
From:       chuck c <bubbasnmp () gmail ! com>
Date:       2020-10-31 18:49:55
Message-ID: CAF4O9rSpCLTEU7GM0WsBdcONcNZ8WSKLLybbxWn4LtMQqewkcA () mail ! gmail ! com
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]


I built my windows dev system to the cookbook and learned about Java.
It's obvious after the fact, but nothing in the docs says Java is required.
And to add insult to injury, the Java installer picked the 32-bit version
first time around.
Has to be the 64-bit version to allocate enough memory.

On Sat, Oct 31, 2020 at 1:42 PM Maynard, Chris via Wireshark-dev <
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?
> - Chris
> [1]: *https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html*
> <https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html>
>
> 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.
> ___________________________________________________________________________
> 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-request@wireshark.org
> ?subject=unsubscribe

[Attachment #5 (text/html)]

<div dir="ltr"><div class="gmail_default" style="font-size:small">I built my windows \
dev system to the cookbook and learned about Java.</div><div class="gmail_default" \
style="font-size:small">It&#39;s obvious after the fact, but nothing in the docs says \
Java is required.</div><div class="gmail_default" style="font-size:small">And to add \
insult to injury, the Java installer picked the 32-bit version first time \
around.</div><div class="gmail_default" style="font-size:small">Has to be the 64-bit \
version to allocate enough memory.</div></div><br><div class="gmail_quote"><div \
dir="ltr" class="gmail_attr">On Sat, Oct 31, 2020 at 1:42 PM Maynard, Chris via \
Wireshark-dev &lt;<a \
href="mailto:wireshark-dev@wireshark.org">wireshark-dev@wireshark.org</a>&gt; \
wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px \
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">






<div>
<font face="Calibri" size="2"><span style="font-size:11pt">
<div><font color="#002060">Section 2.2.8 of the Wireshark Developer's Guide[1] \
instructs you to install <font face="Courier New">asciidoctor</font>, <font \
face="Courier New">xsltproc</font> and <font face="Courier New">docbook</font> if you \
want to build the Wireshark documentation; however, it doesn't specify the minimum \
version requirements of those tools.</font></div> <div><font color="#002060">  \
</font></div> <div><font color="#002060">Attempting to build the documentation for \
the new 3.4.0 release failed on my system.   Running <font face="Courier \
New">&quot;</font><font face="Courier New">choco list </font><font face="Courier \
New">--</font><font face="Courier New">localonly</font><font face="Courier \
New">&quot;</font> showed that I had these relevant package versions \
installed:</font></div> <div><font face="Calibri" color="#002060">  </font></div>
<div style="padding-left:36pt"><font face="Lucida Console" size="2"><span \
style="font-size:10pt">asciidoctorj 2.1.0</span></font></div> <div \
style="padding-left:36pt"><font face="Lucida Console" size="2"><span \
style="font-size:10pt">docbook-bundle 1.0.0</span></font></div> <div \
style="padding-left:36pt"><font face="Lucida Console" size="2"><span \
style="font-size:10pt">xsltproc 1.1.28.0</span></font></div> <div><font \
face="Calibri" color="#002060">  </font></div> <div><font color="#002060">… and \
running <font face="Courier New">&quot;</font><font face="Courier New">choco \
outdated</font><font face="Courier New">&quot;</font> revealed that <font \
face="Courier New">asciidoctor</font> was outdated:</font></div> <div><font \
face="Calibri" color="#002060">  </font></div> <div style="padding-left:36pt"><font \
face="Lucida Console" size="2"><span style="font-size:10pt">Chocolatey \
v0.10.15</span></font></div> <div style="padding-left:36pt"><font face="Lucida \
Console" size="2"><span style="font-size:10pt">Outdated Packages</span></font></div> \
<div style="padding-left:36pt"><font face="Lucida Console" size="2"><span \
style="font-size:10pt"> Output is package name | current version | available version \
| pinned?</span></font></div> <div style="padding-left:36pt"><font face="Lucida \
Console" size="2"><span style="font-size:10pt">  </span></font></div> <div \
style="padding-left:36pt"><font face="Lucida Console" size="2"><span \
style="font-size:10pt">asciidoctorj|2.1.0|2.3.0|false</span></font></div> <div><font \
face="Calibri" color="#002060">  </font></div> <div><font color="#002060">I updated \
the <font face="Courier New">asciidoctor</font> package to version 2.3.0 and was able \
to successfully build the documentation.   (NOTE: I actually ran <font face="Courier \
New">&quot;</font><font face="Courier New">choco upgrade all</font><font \
face="Courier New">&quot;</font> 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.</font></div> <div><font \
face="Calibri" color="#002060">  </font></div> <div><font color="#002060">And perhaps \
the Developer's Guide should mention minimum required versions, if \
possible?</font></div> <div><font color="#002060">- Chris</font></div>
<div><font color="#002060">[1]: <a \
href="https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html" \
target="_blank"><font \
color="#0563C1"><u>https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html</u></font></a></font></div>
 <div><font face="Calibri">  </font></div>
<div><font face="Times New Roman">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. </font></div>
</span></font>
</div>

___________________________________________________________________________<br>
Sent via:      Wireshark-dev mailing list &lt;<a \
href="mailto:wireshark-dev@wireshark.org" \
                target="_blank">wireshark-dev@wireshark.org</a>&gt;<br>
Archives:      <a href="https://www.wireshark.org/lists/wireshark-dev" \
rel="noreferrer" target="_blank">https://www.wireshark.org/lists/wireshark-dev</a><br>
                
Unsubscribe: <a href="https://www.wireshark.org/mailman/options/wireshark-dev" \
rel="noreferrer" target="_blank">https://www.wireshark.org/mailman/options/wireshark-dev</a><br>
  mailto:<a href="mailto:wireshark-dev-request@wireshark.org" \
target="_blank">wireshark-dev-request@wireshark.org</a>?subject=unsubscribe</blockquote></div>



[Attachment #6 (text/plain)]

___________________________________________________________________________
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-request@wireshark.org?subject=unsubscribe

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic