Wireshark · Wireshark-dev: Re: [Wireshark-dev] Windows build - all_guides fails on .chm files

[Gerald Combs <gerald@xxxxxxxxxxxxx>]

We currently create a .chm on Windows because a) that's what we've traditionally done, b) it lets us jump to a specific place in the documentation from the main UI, and c) it's searchable. docbook/README.adoc mentions WebHelp, PDF, and Qt Help as possible alternatives to HTML Help. We could also generate an HTML book using Antora[1] or possibly mdBook[2], although it would require conversion to Markdown.

It might also be useful to move the documentation builds to GitLab's CI and download the User's Guide using win-setup.ps1 instead of forcing Windows developers to install the .chm toolchain.

[1]https://antora.org/
[2]https://rust-lang.github.io/mdBook/


On 11/19/20 8:30 AM, chuck c wrote:
> Fixed: Microsoft HTML Help Workshop missing.
> Todo: Update documentation for creating build machine with link to tools needed and find link to proper download.
> 
> "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" -P C:/Development/wireshark/cmake/modules/hhc.cmake HTML_HELP_COMPILER-NOTFOUND user-guide.hhp
> 
> Not found
> --------------
> -- Selecting Windows SDK version 10.0.18362.0 to target Windows 10.0.17763.
> -- Generating build using CMake 3.18.20081302-MSVC_2
> -- LTO/IPO is enabled
> -- Building for win64 using Visual Studio 16 2019
> Working in C:\Development\wireshark-win64-libs
> 
> Tag 2020-09-30 found. Skipping.
> 
> -- CMake build type: RelWithDebInfo
> -- V: 3.5.0-CDC_201118, MaV: 3, MiV: 5, PL: 0, EV: -CDC_201118.
> -- Linker flags: /LARGEADDRESSAWARE /MANIFEST:NO /INCREMENTAL:NO /RELEASE /guard:cf
> -- Could NOT find DOXYGEN (missing: DOXYGEN_EXECUTABLE)
> -- Could NOT find SpeexDSP (missing: SPEEXDSP_LIBRARY SPEEXDSP_INCLUDE_DIR) (found version "")
> -- Could NOT find HTMLHelp (missing: HTML_HELP_COMPILER)
> <snip>
> 
> Download and install HTML Help workshop
> 
> -- Found HTMLHelp: C:/Program Files (x86)/HTML Help Workshop/hhc.exe 
> 
> 
> https://www.wireshark.org/docs/wsdg_html_chunked/ChToolsDocumentationToolchain.html <https://www.wireshark.org/docs/wsdg_html_chunked/ChToolsDocumentationToolchain.html>
> "4.6.4. HTML Help
> HTML Help is used to create the User’s and Developer’s Guide in .chm format."
> 
> 
> On Wed, Nov 18, 2020 at 8:57 PM chuck c <bubbasnmp@xxxxxxxxx <mailto:bubbasnmp@xxxxxxxxx>> wrote:
> 
>     New  Windows 10 build system so might be due to tool versions.
> 
>     Any tips on how to diagnose this?
> 
> 
>       "The build of 'C:\Development\wsbuild64\CMakeFiles\470a6095470174e9ce53bf13b7d8b057\developer_guide_chm.rule' depends on 'C:\DEVELOPMENT\WSBUILD64\DOCBOOK\DEVELOPER-GUIDE.CHM' which is produced by the build of 'C:\Development\wsbuild64\CMakeFiles\f552b4b7ccfbf74b38fc77eac37cc368\developer-guide.chm.rule'. The items cannot be built in parallel."
>       "The build of 'C:\Development\wsbuild64\CMakeFiles\470a6095470174e9ce53bf13b7d8b057\user_guide_chm.rule' depends on 'C:\DEVELOPMENT\WSBUILD64\DOCBOOK\USER-GUIDE.CHM' which is produced by the build of 'C:\Development\wsbuild64\CMakeFiles\f552b4b7ccfbf74b38fc77eac37cc368\user-guide.chm.rule'. The items cannot be built in parallel."
> 
>     <snip>
> 
>     Build succeeded.
> 
>     "C:\Development\wsbuild64\docbook\all_guides.vcxproj" (default target) (1) ->
>     "C:\Development\wsbuild64\docbook\developer_guides.vcxproj" (default target) (3) ->
>     "C:\Development\wsbuild64\docbook\developer_guide_chm.vcxproj" (default target) (4) ->
>     (CustomBuild target) ->
>       C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Microsoft\VC\v160\Microsoft.CppCommon.targets(238,5): warning MSB8065: Custom build for item "C:\Development\wsbuild64\CMakeFiles\f552b4b7ccfbf74b38fc77eac37cc368\developer-guide.chm.rule" succeeded, but specified output "c:\development\wsbuild64\docbook\developer-guide.chm" has not been created. This may cause incremental build to work incorrectly. [C:\Development\wsbuild64\docbook\developer_guide_chm.vcxproj]
> 
> 
>     "C:\Development\wsbuild64\docbook\all_guides.vcxproj" (default target) (1) ->
>     "C:\Development\wsbuild64\docbook\user_guides.vcxproj" (default target) (10) ->
>     "C:\Development\wsbuild64\docbook\user_guide_chm.vcxproj" (default target) (11) ->
>       C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Microsoft\VC\v160\Microsoft.CppCommon.targets(238,5): warning MSB8065: Custom build for item "C:\Development\wsbuild64\CMakeFiles\f552b4b7ccfbf74b38fc77eac37cc368\user-guide.chm.rule" succeeded, but specified output "c:\development\wsbuild64\docbook\user-guide.chm" has not been created. This may cause incremental build to work incorrectly. [C:\Development\wsbuild64\docbook\user_guide_chm.vcxproj]
> 
>         2 Warning(s)
>         0 Error(s)
> 
>     Time Elapsed 00:00:05.45
> 
> 
> ___________________________________________________________________________
> Sent via:    Wireshark-dev mailing list <wireshark-dev@xxxxxxxxxxxxx>
> Archives:    https://www.wireshark.org/lists/wireshark-dev
> Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-dev
>              mailto:wireshark-dev-request@xxxxxxxxxxxxx?subject=unsubscribe
>