Wireshark · Wireshark-dev: Re: [Wireshark-dev] Is there a way to disable documentation generation?

[Michael Lum <michael.lum@xxxxxxxxxxxxxxxxx>]

Thanks Graham,

 

I ended up getting it work with documentation as well but I also had to grab udpdump.pod from the latest

source because it was missing from the 2.4.0 source.

---

From: Wireshark-dev [mailto:wireshark-dev-bounces@xxxxxxxxxxxxx] On Behalf Of Graham Bloice
Sent: August-02-17 3:30 AM
To: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Is there a way to disable documentation generation?

Michael,

I've never run into this issue as I have (always) had Cygwin in C:\Cygwin.

Interestingly, the build slaves (https://buildbot.wireshark.org/wireshark-master/waterfall) have Cygwin in C:\Cygwin64 and they don't define the WIRESHARK_CYGWIN_INSTALL_PATH env var.

Gerald has been making some changes in this area lately to better detect Cygwin, so maybe update to the latest master sources.

The issue with CMake 3.9 has also been fixed again with the latest sources.

On 1 August 2017 at 22:02, Michael Lum <michael.lum@xxxxxxxxxxxxxxxxx> wrote:

It works when I change:

 

set WIRESHARK_CYGWIN_INSTALL_PATH=c:\cygwin64

 

to

 

set WIRESHARK_CYGWIN_INSTALL_PATH=c:/cygwin64

 

This has changed since 2.2.5 or it has something to do with cmake 3.8.2 versus cmake 3.5.

 

When I first tried to build 2.4.0 I received a complaint saying that at least cmake 3.7 was required.

I installed the latest (cmake 3.9) but that didn't work so I went to 3.8.2.

 

Thanks Graham.

 

The Windows portion of the developers guide use the backslash and does not specify a cmake version.

---

From: Wireshark-dev [mailto:wireshark-dev-bounces@wireshark.org] On Behalf Of Michael Lum
Sent: August-01-17 1:47 PM

To: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Is there a way to disable documentation generation?

This is from my 2.2.5 build with the same "message" calls added:

 

-- CYGWIN_INSTALL_PATH=C:/cygwin64
-- l_a2x_ex=c:/cygwin64/bin/a2x
-- l_cyg_path=c:/cygwin64
-- Using Cygwin a2x

---

From: Wireshark-dev [mailto:wireshark-dev-bounces@wireshark.org] On Behalf Of Michael Lum
Sent: August-01-17 1:44 PM
To: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Is there a way to disable documentation generation?

I added some "message" output to the FindASCII script:

 

-- CYGWIN_INSTALL_PATH=c:\cygwin64
-- l_a2x_ex=c:/cygwin64/bin/a2x
-- l_cyg_path=c:\cygwin64

 

I don't know how the cmake "MATCHES" is supposed to work.

Is it a simple substring match or does it take care of \ /?

---

From: Wireshark-dev [mailto:wireshark-dev-bounces@wireshark.org] On Behalf Of Michael Lum
Sent: August-01-17 11:16 AM
To: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Is there a way to disable documentation generation?

That variable is always set.

 

"WIRESHARK_CYGWIN_INSTALL_PATH=c:\cygwin64"

 

I use a .cmd file to set the environment as per the development guide.

---

From: Wireshark-dev [mailto:wireshark-dev-bounces@wireshark.org] On Behalf Of Graham Bloice
Sent: August-01-17 10:44 AM
To: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Is there a way to disable documentation generation?

On 1 August 2017 at 18:10, Michael Lum <michael.lum@xxxxxxxxxxxxxxxxx> wrote:

Hi Graham,

 

thanks for the help.

 

I wasn't sure if you wanted to see the CMake generation with/without the "-D ENABLE_CHM_GUIDES"

so I ran it with the redirection WITH documentation.

 

I removed CMakeCache.txt first.

 

cmake -DPYTHON_EXECUTABLE=c:\Python27\python -DENABLE_CHM_GUIDES=on -G "Visual Studio 12 2013 Win64" %myPath% 2>&1 > cmake.txt

 

The output in the shell window (if it matters):

 

cmake -DPYTHON_EXECUTABLE=c:\Python27\python -DENABLE_CHM_GUIDES=on -G "Visual Studio 12 2013 Win64" C:\wireshark-2.4.0\
statuscheck linker flag - test linker flags: -Wl,--as-needed
statuscheck linker flag - test linker flags: -pie

 

C:\ws240-64>

 

I've attached the cmake.txt output file.

 

Let me know if you need anything else.

 

BR

 

Michael Lum

The odd bit of your CMake output is:

  -- Found ASCIIDOC: LC_ALL=C;TZ=UTC;C:/cygwin64/bin/a2x  

whereas I have:

  -- Using Cygwin a2x

  -- Found ASCIIDOC: C:/Cygwin/bin/bash.exe;/cygdrive/e/Wireshark/wireshark/tools/runa2x.sh  

Looking at the FindASIIDOC.cmake module (in top-level-source\cmake\modules), your output happens if the path to a2x doesn't include the CYGWIN_INSTALL_PATH.

Can you try setting an environment variable WIRESHARK_CYGWIN_INSTALL_PATH tp C:\Cygwin64 and re-running cmake, deleting the cache first?

 

---

From: Wireshark-dev [mailto:wireshark-dev-bounces@wireshark.org] On Behalf Of Graham Bloice
Sent: August-01-17 6:42 AM
To: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Is there a way to disable documentation generation?

On 1 August 2017 at 14:15, Graham Bloice <graham.bloice@xxxxxxxxxxxxx> wrote:

On 31 July 2017 at 23:06, Michael Lum <michael.lum@xxxxxxxxxxxxxxxxx> wrote:

Is there a way to disable the documentation generation?

 

The 2.4.0 source will not build for me under Windows 7, cmake 3.8.2

 

 

  set WIRESHARK_BASE_DIR=C:\ws240-64

 

  REM
  REM Note if you want to change this AFTER you have built:
  REM Do 'clean', then 'prep', then 'build', 'package'
  REM
  set WIRESHARK_VERSION_EXTRA=-StarSolutions-1

 

  set CYGWIN=nodosfilewarning
  set WIRESHARK_TARGET_PLATFORM=win64
  set QT5_BASE_DIR=C:\Qt\Qt5.6.2\5.6\msvc2013_64
  set WIRESHARK_CYGWIN_INSTALL_PATH=c:\cygwin64

 

Built from the command-line with:

 

msbuild /m /p:Configuration=RelWithDebInfo Wireshark.sln

 

===============================================================================================

The errors are related to LC_ALL.

 

    34>CustomBuild:
         All outputs are up-to-date.
       ClCompile:
         All outputs are up-to-date.
     1>Project "C:\ws240-64\Wireshark.sln" (1) is building "C:\ws240-64\docbook\all_guides.vcxproj.metaproj" (3) on node 1 (default targets).
     3>Project "C:\ws240-64\docbook\all_guides.vcxproj.metaproj" (3) is building "C:\ws240-64\docbook\user_guides.vcxproj.metaproj" (23) on node 1 (default targets).
    23>Project "C:\ws240-64\docbook\user_guides.vcxproj.metaproj" (23) is building "C:\ws240-64\docbook\user_guide_chm.vcxproj.metaproj" (24) on node 1 (default targets).
    24>Project "C:\ws240-64\docbook\user_guide_chm.vcxproj.metaproj" (24) is building "C:\ws240-64\docbook\generate_user-guide.xml.vcxproj.metaproj" (26) on node 1 (default targets).
    26>Project "C:\ws240-64\docbook\generate_user-guide.xml.vcxproj.metaproj" (26) is building "C:\ws240-64\docbook\generate_user-guide.xml.vcxproj" (32) on node 3 (default targets).
    32>InitializeBuildStatus:
         Creating "x64\RelWithDebInfo\generate_user-guide.xml\generate.76CA933A.tlog\unsuccessfulbuild" because "AlwaysCreate" was specified.
    34>Lib:
         All outputs are up-to-date.
         ui.vcxproj -> C:\ws240-64\run\RelWithDebInfo\ui.lib
    32>CustomBuild:
         Generating user-guide.xml
         'LC_ALL' is not recognized as an internal or external command,
         operable program or batch file.
    32>C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V120\Microsoft.CppCommon.targets(170,5): error MSB6006: "cmd.exe" exited with code 9009. [C:\ws240-64\docbook\generate_user-guide.xml.vcxproj]
    32>Done Building Project "C:\ws240-64\docbook\generate_user-guide.xml.vcxproj" (default targets) -- FAILED.

 

=======================================================================================

It's breaking in docbook eventhough I have the packages listed in the developer's guide:

 

asciidoc 8.6.9-1

biber 2.5-1

build-docbook-catalog 1.5-2

dblatex 0.3.10-1

docbook-xml45 4.5-1

docbook-xsl 1.77.1-1

groff 1.22.3-1

iso-codes 3.75-1

less 487-1

libaspell15 0.60.6.1-1

libteckit0 2.5.6-1

libthai0 0.1.26-1

poppler-data 0.4.7-1

sgml-common 0.6.3-3

suomi-malaga 1.19-1

xmlto 0.0.26-1

 

 

Michael Lum (michael.lum@xxxxxxxxxxxxxxxxx) | STAR SOLUTIONS | Principal Software Engineer

4600 Jacombs Road, Richmond BC, Canada V6V 3B1 | +1.604.303.2315

 

This has been reported a couple of times before, both on the mail list and on Ask Wireshark (I suspect it was the same user), unfortunately the original poster never responded to questions.

The build of docs can be disabled by omitting the "-D " argument to the CMake generation step, however you still need a working asciidoc toolset to produce the release notes.

This should have read "by omitting the "-D ENABLE_CHM_GUIDES" argument.  You might need to delete CMakeCache.txt before regenerating the build files.

 

Can you post the output of the CMake generation step by redirecting it to a file, i.e.

 cmake ... 2>&1 > cmake.txt

--

Graham Bloice