Wireshark-dev: Re: [Wireshark-dev] Documentation : 9.6. How to produce protocol stats merge req

From: "Maynard, Christopher" <Christopher.Maynard@xxxxxxx>
Date: Thu, 24 Dec 2020 16:49:01 +0000
> From: Wireshark-dev <wireshark-dev-bounces@xxxxxxxxxxxxx> On Behalf Of Graham Bloice
> Sent: Thursday, December 24, 2020 6:10 AM
> To: Developer support list for Wireshark <wireshark-dev@xxxxxxxxxxxxx>
> Subject: Re: [Wireshark-dev] Documentation : 9.6. How to produce protocol stats merge request
>
>> On Thu, 24 Dec 2020 at 10:49, wsgd <mailto:wsgd@xxxxxxx> wrote:
>> Hello,
>>
>>
>> Thanks for the merge request
>> I setup an environment (clone ...) to be able to do it
>>
>> Question : how can I generate the documentation when I modify WSDG_chapter_dissection.adoc ?
>>
>
> On Windows, CMake generates additional targets for Visual Studio to build the documentation and uninstaller and then build the installer.  These targets are explained https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html#_optional_create_users_and_developers_guide, the nsis_package_prep target builds the docs.
>
> There is also build info in https://gitlab.com/wireshark/wireshark/-/blob/master/docbook/README.adoc, not entirely sure that's up to date as I've never used those targets.

To build the documentation, the Windows buildbots run the following from the docbook build directory:

    msbuild /consoleloggerparameters:PerformanceSummary;NoSummary /maxcpucount all_guides.vcxproj

This is what I use as well.

You can check all build steps of the various buildbots here: https://buildbot.wireshark.org/wireshark-master/waterfall
- 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.