osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity
wireshark/doc/CMakeLists.txt

143 lines
3.5 KiB
CMake
Raw Normal View History

Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
# CMakeLists.txt
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
replace SPDX identifier GPL-2.0+ with GPL-2.0-or-later. The first is deprecated, as per https://spdx.org/licenses/. Change-Id: I8e21e1d32d09b8b94b93a2dc9fbdde5ffeba6bed Reviewed-on: https://code.wireshark.org/review/25661 Petri-Dish: Anders Broman <a.broman58@gmail.com> Petri-Dish: Dario Lombardo <lomato@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-07 11:26:45 +00:00
# SPDX-License-Identifier: GPL-2.0-or-later
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
#
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
find_package( Asciidoctor 1.5 )
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
set(MAN1_SOURCE_FILES)
set(MAN4_SOURCE_FILES)
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
set(MAN1_INSTALL_FILES)
set(MAN4_INSTALL_FILES)
CMake: Partially revert recent docs changes. Revert recent "docs" target changes. It made that target build faster, but broke other dependencies. Keep the AsciidoctorJ changes. Revert "doc: fix the macOS build." This reverts commit 119667d886c111b6feab703953624d56c756fdd6. Revert "CMake: Try to make our man page builds faster." This reverts commit 74747c4d2ffef25c20d950525aa316bb5e2a0700.
2021-10-14 17:00:23 +00:00
set(HTML_INSTALL_FILES)
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
macro (ADD_MAN_PAGE _page_name _man_section)
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
if(ASCIIDOCTOR_FOUND)
CMake: Partially revert recent docs changes. Revert recent "docs" target changes. It made that target build faster, but broke other dependencies. Keep the AsciidoctorJ changes. Revert "doc: fix the macOS build." This reverts commit 119667d886c111b6feab703953624d56c756fdd6. Revert "CMake: Try to make our man page builds faster." This reverts commit 74747c4d2ffef25c20d950525aa316bb5e2a0700.
2021-10-14 17:00:23 +00:00
list(APPEND HTML_INSTALL_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_page_name}.html)
CMake+Docs: Try to build our man pages in parallel. Make sure man pages are included in the default build. Have the docs and copy_data_files targets explicitly depend on the man page generator targets.
2021-10-18 18:46:06 +00:00
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
if (${_man_section} EQUAL 1)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
list(APPEND MAN1_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/${_page_name}.adoc)
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
list(APPEND MAN1_INSTALL_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_page_name}.${_man_section})
elseif (${_man_section} EQUAL 4)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
list(APPEND MAN4_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/${_page_name}.adoc)
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
list(APPEND MAN4_INSTALL_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_page_name}.${_man_section})
else()
message(FATAL_ERROR "Unsupported manual page section ${_man_section} for ${_page_name}")
endif()
endif()
endmacro()
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(wireshark 1)
ADD_MAN_PAGE(androiddump 1)
ADD_MAN_PAGE(capinfos 1)
ADD_MAN_PAGE(captype 1)
ADD_MAN_PAGE(ciscodump 1)
ADD_MAN_PAGE(dumpcap 1)
ADD_MAN_PAGE(editcap 1)
ADD_MAN_PAGE(mergecap 1)
ADD_MAN_PAGE(randpkt 1)
ADD_MAN_PAGE(randpktdump 1)
ADD_MAN_PAGE(etwdump 1)
ADD_MAN_PAGE(rawshark 1)
ADD_MAN_PAGE(reordercap 1)
ADD_MAN_PAGE(sshdump 1)
ADD_MAN_PAGE(text2pcap 1)
ADD_MAN_PAGE(tshark 1)
extcap: Add falcodump. Add an extcap that fetches a scap from a Falco/libsinsp plugin. Tested using the cloudtrail plugin.
2022-03-17 20:56:37 +00:00
ADD_MAN_PAGE(falcodump 1)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(udpdump 1)
extcap: new interface, wifidump, to capture Wi-Fi frames using a remote SSH host
2022-03-08 21:38:13 +00:00
ADD_MAN_PAGE(wifidump 1)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(extcap 4)
ADD_MAN_PAGE(wireshark-filter 4)
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
Build the dpauxmon documentation. Add dpauxmon entries to the doc targets. Change-Id: I7a9ac76897c770892a9eac3c2de5da626e3f7ac4 Reviewed-on: https://code.wireshark.org/review/29466 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-09-07 15:57:12 +00:00
if(BUILD_dpauxmon AND HAVE_LIBNL3)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(dpauxmon 1)
Build the dpauxmon documentation. Add dpauxmon entries to the doc targets. Change-Id: I7a9ac76897c770892a9eac3c2de5da626e3f7ac4 Reviewed-on: https://code.wireshark.org/review/29466 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-09-07 15:57:12 +00:00
endif()
Add a systemd Journal Export extcap. Add an sdjournal extcap, which reads journal entries using the sd-journal API and dumps them as journal Export Format records. Change-Id: I17ccfa88ab5d053c16c869cd26e580d84022502e Reviewed-on: https://code.wireshark.org/review/29479 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-09-05 23:29:34 +00:00
if(BUILD_sdjournal AND SYSTEMD_FOUND)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(sdjournal 1)
Add a systemd Journal Export extcap. Add an sdjournal extcap, which reads journal entries using the sd-journal API and dumps them as journal Export Format records. Change-Id: I17ccfa88ab5d053c16c869cd26e580d84022502e Reviewed-on: https://code.wireshark.org/review/29479 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-09-05 23:29:34 +00:00
endif()
Transition from GeoIP Legacy to MaxMindDB. MaxMind is discontinuing its legacy databases in April in favor of GeoIP2, which use a newer database format (MaxMind DB). The reference C library (libmaxminddb) is available under the Apache 2.0 license which isn't quite compatible with ours. Add mmdbresolve, a utility that reads IPv4 and IPv6 addresses on stdin and prints resolved information on stdout. Place it under a liberal license (MIT) so that we can keep libmaxminddb at arm's length. Add epan/maxmind_db.[ch], which spawns mmdbresolve and communicates with it via stdio. Migrate the preferences and documentation to MaxMindDB. Change the IPv4 and IPv6 asnum fields to FT_UINT32s. Change the geographic coordinate fields to FT_DOUBLEs. Bug: 10658 Change-Id: I24aeed637bea1b41d173270bda413af230f4425f Reviewed-on: https://code.wireshark.org/review/26214 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-09 01:20:26 +00:00
if(MAXMINDDB_FOUND)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(mmdbresolve 1)
Transition from GeoIP Legacy to MaxMindDB. MaxMind is discontinuing its legacy databases in April in favor of GeoIP2, which use a newer database format (MaxMind DB). The reference C library (libmaxminddb) is available under the Apache 2.0 license which isn't quite compatible with ours. Add mmdbresolve, a utility that reads IPv4 and IPv6 addresses on stdin and prints resolved information on stdout. Place it under a liberal license (MIT) so that we can keep libmaxminddb at arm's length. Add epan/maxmind_db.[ch], which spawns mmdbresolve and communicates with it via stdio. Migrate the preferences and documentation to MaxMindDB. Change the IPv4 and IPv6 asnum fields to FT_UINT32s. Change the geographic coordinate fields to FT_DOUBLEs. Bug: 10658 Change-Id: I24aeed637bea1b41d173270bda413af230f4425f Reviewed-on: https://code.wireshark.org/review/26214 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-09 01:20:26 +00:00
endif()
Sync some CMake and Autotools install behaviors. Adjust the following CMake and Autotools behaviors in order to synchronize their respective install behaviors: - Disable tfshark by default in CMakeOptions.txt - Add profiles/Bluetooth/preferences to Makefile.am - Add missing captype and ciscodump entries to doc/Makefile.am - Install help/faq.txt on all platforms in CMakeLists.txt - Add BUILD_corbaidl2wrs, BUILD_dcerpcidl2wrs, and BUILD_xxx2deb options to CMake and use them to adjust the corresponding parts of the build. - Pull the DCERPC idl2wrs build steps into the top-level CMakeLists.txt. This change doesn't sync everything. Some installed content still diverges, including the following: - CMake installs a bunch of modules into lib/wireshark: FindGLIB2.cmake FindWireshark.cmake FindWSWinLibs.cmake LocatePythonModule.cmake UseAsn2Wrs.cmake UseMakeDissectorReg.cmake WiresharkConfig.cmake WiresharkConfigVersion.cmake Do we need any or all of these? If so, should the Autotools behavior be synced accordingly? - Autotools installs libtool .la files. It also installs wireshark-gtk.desktop unconditionally. Change-Id: I7846efe08f7139c31b6ceca6f08a1fa5168b3e22 Reviewed-on: https://code.wireshark.org/review/23041 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-08-10 17:20:30 +00:00
if (BUILD_corbaidl2wrs)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(idl2wrs 1)
Transition from GeoIP Legacy to MaxMindDB. MaxMind is discontinuing its legacy databases in April in favor of GeoIP2, which use a newer database format (MaxMind DB). The reference C library (libmaxminddb) is available under the Apache 2.0 license which isn't quite compatible with ours. Add mmdbresolve, a utility that reads IPv4 and IPv6 addresses on stdin and prints resolved information on stdout. Place it under a liberal license (MIT) so that we can keep libmaxminddb at arm's length. Add epan/maxmind_db.[ch], which spawns mmdbresolve and communicates with it via stdio. Migrate the preferences and documentation to MaxMindDB. Change the IPv4 and IPv6 asnum fields to FT_UINT32s. Change the geographic coordinate fields to FT_DOUBLEs. Bug: 10658 Change-Id: I24aeed637bea1b41d173270bda413af230f4425f Reviewed-on: https://code.wireshark.org/review/26214 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-09 01:20:26 +00:00
endif()
Sync some CMake and Autotools install behaviors. Adjust the following CMake and Autotools behaviors in order to synchronize their respective install behaviors: - Disable tfshark by default in CMakeOptions.txt - Add profiles/Bluetooth/preferences to Makefile.am - Add missing captype and ciscodump entries to doc/Makefile.am - Install help/faq.txt on all platforms in CMakeLists.txt - Add BUILD_corbaidl2wrs, BUILD_dcerpcidl2wrs, and BUILD_xxx2deb options to CMake and use them to adjust the corresponding parts of the build. - Pull the DCERPC idl2wrs build steps into the top-level CMakeLists.txt. This change doesn't sync everything. Some installed content still diverges, including the following: - CMake installs a bunch of modules into lib/wireshark: FindGLIB2.cmake FindWireshark.cmake FindWSWinLibs.cmake LocatePythonModule.cmake UseAsn2Wrs.cmake UseMakeDissectorReg.cmake WiresharkConfig.cmake WiresharkConfigVersion.cmake Do we need any or all of these? If so, should the Autotools behavior be synced accordingly? - Autotools installs libtool .la files. It also installs wireshark-gtk.desktop unconditionally. Change-Id: I7846efe08f7139c31b6ceca6f08a1fa5168b3e22 Reviewed-on: https://code.wireshark.org/review/23041 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-08-10 17:20:30 +00:00
if (BUILD_xxx2deb)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
ADD_MAN_PAGE(asn2deb 1)
ADD_MAN_PAGE(idl2deb 1)
Sync some CMake and Autotools install behaviors. Adjust the following CMake and Autotools behaviors in order to synchronize their respective install behaviors: - Disable tfshark by default in CMakeOptions.txt - Add profiles/Bluetooth/preferences to Makefile.am - Add missing captype and ciscodump entries to doc/Makefile.am - Install help/faq.txt on all platforms in CMakeLists.txt - Add BUILD_corbaidl2wrs, BUILD_dcerpcidl2wrs, and BUILD_xxx2deb options to CMake and use them to adjust the corresponding parts of the build. - Pull the DCERPC idl2wrs build steps into the top-level CMakeLists.txt. This change doesn't sync everything. Some installed content still diverges, including the following: - CMake installs a bunch of modules into lib/wireshark: FindGLIB2.cmake FindWireshark.cmake FindWSWinLibs.cmake LocatePythonModule.cmake UseAsn2Wrs.cmake UseMakeDissectorReg.cmake WiresharkConfig.cmake WiresharkConfigVersion.cmake Do we need any or all of these? If so, should the Autotools behavior be synced accordingly? - Autotools installs libtool .la files. It also installs wireshark-gtk.desktop unconditionally. Change-Id: I7846efe08f7139c31b6ceca6f08a1fa5168b3e22 Reviewed-on: https://code.wireshark.org/review/23041 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-08-10 17:20:30 +00:00
endif()
CMake: Split more Wireshark/Logray variables. Split our macOS application bundle variables into Wireshark- and Logray-specific ones. Make sure Logray's PkgInfo and CFBundleSignature match.
2022-09-01 00:59:36 +00:00
set(WIRESHARK_BUNDLE_RESOURCE_SHARE_MAN1_FILES ${MAN1_INSTALL_FILES} PARENT_SCOPE)
set(WIRESHARK_BUNDLE_RESOURCE_SHARE_MAN4_FILES ${MAN4_INSTALL_FILES} PARENT_SCOPE)
# XXX We need a Logray-specific man page list, which might overlap with Wireshark's.
# Just install everything for now.
set(LOGRAY_BUNDLE_RESOURCE_SHARE_MAN1_FILES ${WIRESHARK_BUNDLE_RESOURCE_SHARE_MAN1_FILES} PARENT_SCOPE)
set(LOGRAY_BUNDLE_RESOURCE_SHARE_MAN4_FILES ${WIRESHARK_BUNDLE_RESOURCE_SHARE_MAN4_FILES} PARENT_SCOPE)
CMakeLists: Add man files Current Wireshark.app bundle on OS X doesn't include man pages. This is the second try after commit 7da23ca1a5bba4af5e1104f4d3d3d44e918552b0 has been reverted. Now cmake gets the information that the man files are generated. Bug: 12746 Change-Id: I34dfec65bd57587ee048d7e1e2557fc9ab2b32eb Reviewed-on: https://code.wireshark.org/review/18170 Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Guy Harris <guy@alum.mit.edu>
2016-10-12 19:55:54 +00:00
Docs: Document our diagnostic output options. Add docs/diagnostic-options.adoc, which is a snippet that documents our various --log-* options. Include it in the dumpcap, rawshark, and tshark man pages. Make the ws_log_print_usage output more consistent.
2021-12-26 17:35:37 +00:00
set(MAN_INCLUDES diagnostic-options.adoc)
CMake+Docs: Generate man pages all at once. Asciidoctor lets us generate multiple documents at once, so do so for our man pages. If we're using AsciidoctorJ this minimizes the number of JVM instances we have to spin up. This reduces the build time on my Windows VM here quite a bit, and will hopefully do so on the CI builders. Add a .editorconfig file in cmake/modules.
2021-10-19 21:09:13 +00:00
if(ASCIIDOCTOR_FOUND)
ASCIIDOCTOR2ROFFMAN(1 ${MAN1_SOURCE_FILES})
ASCIIDOCTOR2ROFFMAN(4 ${MAN4_SOURCE_FILES})
ASCIIDOCTOR2HTMLMAN(${MAN1_SOURCE_FILES} ${MAN4_SOURCE_FILES})
CMake+Docs: Update our man page targets. Remove the generate_*_pages targets that were recently introduced, since they're not really needed. Only add the "manpages" target if we have Asciidoctor.
2021-10-20 16:32:37 +00:00
add_custom_target(manpages DEPENDS
${MAN1_INSTALL_FILES}
${MAN4_INSTALL_FILES}
)
CMake: Place all of the documentation in the "Documentation" folder.
2021-10-20 22:23:19 +00:00
set_target_properties(manpages PROPERTIES FOLDER "Documentation")
CMake+Docs: Update our man page targets. Remove the generate_*_pages targets that were recently introduced, since they're not really needed. Only add the "manpages" target if we have Asciidoctor.
2021-10-20 16:32:37 +00:00
endif()
cmake: add dependency to build manual pages "add_custom_command" outputs are only available as dependency in the same directory, so create a new target such it can be used from the main directory. This fixes the OS X build with no parallelism (-j1). Change-Id: I66aa5ae307be38ee715456a05fd55f55e4fa76e9 Reviewed-on: https://code.wireshark.org/review/18299 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Roland Knall <rknall@gmail.com>
2016-10-19 13:54:32 +00:00
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
add_custom_target(
docs ALL
DEPENDS
CMake: Partially revert recent docs changes. Revert recent "docs" target changes. It made that target build faster, but broke other dependencies. Keep the AsciidoctorJ changes. Revert "doc: fix the macOS build." This reverts commit 119667d886c111b6feab703953624d56c756fdd6. Revert "CMake: Try to make our man page builds faster." This reverts commit 74747c4d2ffef25c20d950525aa316bb5e2a0700.
2021-10-14 17:00:23 +00:00
${MAN1_INSTALL_FILES}
${MAN4_INSTALL_FILES}
${HTML_INSTALL_FILES}
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
)
CMake: Place all of the documentation in the "Documentation" folder.
2021-10-20 22:23:19 +00:00
set_target_properties(docs PROPERTIES FOLDER "Documentation")
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
if(ASCIIDOCTOR_FOUND)
install(
FILES
${MAN1_INSTALL_FILES}
DESTINATION
${CMAKE_INSTALL_MANDIR}/man1
)
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
Docs+Packaging: Convert our man pages to Asciidoctor. Convert doc/*.pod to Asciidoctor. This: * Means we use the same markup for our man pages, the guides, and release notes. * Lets us add versions to our man pages. * Gives us more formatting options, e.g. AsciiDoc supports `commands`, nested lists and makes it easy to include version information. The manpage backend doesn't seem to support tables very well, unfortunately. Convert our CMake configuration to produce *roff and html man pages using Asciidoctor. Add a "manarg" block macro which makes our synopses wrap correctly. Similar to the release notes, guides, and FAQ, if Asciidoctor isn't found the man pages won't be generated or installed. Move Asciidoctor to the list of package build dependencies in various places. This commit includes the conversion script (pod2adoc.py), which will be removed later. Line count sanity check: Man page .pod .adoc androiddump 260 280 asn2deb 93 105 capinfos 401 471 captype 54 55 ciscodump 241 269 dftest 42 42 dpauxmon 153 169 dumpcap 464 534 editcap 528 583 etwdump 136 156 extcap 157 181 idl2deb 91 103 idl2wrs 120 100 mergecap 206 207 mmdbresolve 75 75 randpkt 107 111 randpktdump 158 184 rawshark 558 610 reordercap 76 78 sdjournal 145 157 sshdump 272 302 text2pcap 274 312 tshark 2135 2360 udpdump 133 151 wireshark-filter 486 479 wireshark 2967 3420
2021-06-18 10:20:51 +00:00
install(
FILES
${MAN4_INSTALL_FILES}
DESTINATION
${CMAKE_INSTALL_MANDIR}/man4
)
endif()
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
Install documentation (HTML manuals) to DOCDIR Install documentation to DOCDIR instead of DATADIR. The code must be fixed to open the Help URLs from this new path. This only affects Unix-like FHS platforms. Windows installation does its own thing. Needs testing with macOS packaging.
2023-01-18 14:12:14 +00:00
install(
FILES
${HTML_INSTALL_FILES}
DESTINATION
${CMAKE_INSTALL_DOCDIR}
)
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
#
HTTPS (almost) everywhere. Change all wireshark.org URLs to use https. Fix some broken links while we're at it. Change-Id: I161bf8eeca43b8027605acea666032da86f5ea1c Reviewed-on: https://code.wireshark.org/review/34089 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-07-26 18:43:17 +00:00
# Editor modelines - https://www.wireshark.org/tools/modelines.html
Add doc/CMakeLists.txt Change-Id: I387e893dc5b8b38569f7189d078fdc1853ba012f Reviewed-on: https://code.wireshark.org/review/14269 Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-02-29 14:48:57 +00:00
#
# Local variables:
# c-basic-offset: 8
# tab-width: 8
# indent-tabs-mode: t
# End:
#
# vi: set shiftwidth=8 tabstop=8 noexpandtab:
# :indentSize=8:tabSize=8:noTabs=false:
#