Docs: Move the User's and Developer's Guides to the doc directory

The documentation was originally kept in the "docbook" directory because
it was written in the DocBook markup language. That hasn't been the case
for a long time, so just move everything under "doc".

Move make-wsluarm.py to the tools directory.

CMakeLists.txt

@@ -1698,7 +1698,6 @@ set(PLUGIN_INSTALL_VERSION_LIBDIR "${PLUGIN_INSTALL_LIBDIR}/${PLUGIN_PATH_ID}")
 set(PLUGIN_VERSION_DIR "plugins/${PLUGIN_PATH_ID}")
 
 add_subdirectory( capture )
-add_subdirectory( doc )
 add_subdirectory( epan )
 add_subdirectory( extcap )
 add_subdirectory( randpkt_core )
@@ -1754,9 +1753,9 @@ endif()
 # learn about the directory location.
 add_subdirectory( wsutil )
 
-# docbook must be added after DATAFILE_DIR is set so that the guides can be
+# doc/ must be added after DATAFILE_DIR is set so that the guides can be
 # copied there for running from the build directory
-add_subdirectory( docbook EXCLUDE_FROM_ALL )
+add_subdirectory( doc EXCLUDE_FROM_ALL )
 
 if(BUILD_wireshark AND QT_FOUND)
 	add_subdirectory( ui/qt )
@@ -4091,13 +4090,13 @@ install(
 
 if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
 	install(
-		DIRECTORY "${CMAKE_BINARY_DIR}/docbook/wsug_html_chunked"
+		DIRECTORY "${CMAKE_BINARY_DIR}/doc/wsug_html_chunked"
 		DESTINATION "${CMAKE_INSTALL_DOCDIR}"
 		COMPONENT "UserGuide"
 		EXCLUDE_FROM_ALL
 	)
 	install(
-		DIRECTORY "${CMAKE_BINARY_DIR}/docbook/wsdg_html_chunked"
+		DIRECTORY "${CMAKE_BINARY_DIR}/doc/wsdg_html_chunked"
 		DESTINATION "${CMAKE_INSTALL_DOCDIR}"
 		COMPONENT "DeveloperGuide"
 		EXCLUDE_FROM_ALL

CONTRIBUTING.md

@@ -41,6 +41,6 @@ Complete details on doing so can be found in the [Developer’s Guide](https://w
 When you submit a merge request, a series of automated tests will be run in order to ensure that compiles across different platforms and conforms to our coding guidelines.
 The change will also be manually reviewed by a core developer and will be merged when the change passes both automated and manual review.
 
-The Wireshark User’s Guide and Developer’s Guide are maintained in the [docbook directory](https://gitlab.com/wireshark/wireshark/-/tree/master/docbook) in the main repository.
+The Wireshark User’s Guide and Developer’s Guide are maintained in the [doc directory](https://gitlab.com/wireshark/wireshark/-/tree/master/doc) in the main repository.
 You don’t need a complete development environment to contribute to them, but you do need git and a text editor.
 Documentation updates must be made via a merge request similar to source code changes.

INSTALL

@@ -1,6 +1,6 @@
 See also https://gitlab.com/wireshark/wireshark/-/wikis/Development
 and the Developer's Guide located at https://www.wireshark.org/docs/
-and in the docbook/ subdirectory.
+and in the doc/ subdirectory.
 
 Installation
 ============

README.bsd

@@ -6,7 +6,7 @@ Installing Wireshark on FreeBSD/OpenBSD/NetBSD/DragonFly BSD
 
 For general installation instructions, see the INSTALL file, along with
 the Developer's Guide located at https://www.wireshark.org/docs/ and
-in the docbook/ directory.  Additional BSD specific notes and requirements
+in the doc/ directory.  Additional BSD specific notes and requirements
 follow.
 
 1. Berkeley Packet Filter (BPF) requirement

cmake/modules/FindAsciidoctor.cmake

@@ -45,7 +45,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
         # --failure-level=WARN
         # --trace
         --quiet
-        --attribute build_dir=${CMAKE_BINARY_DIR}/docbook
+        --attribute build_dir=${CMAKE_BINARY_DIR}/doc
         --attribute css_dir=${CMAKE_SOURCE_DIR}/doc
         --require ${CMAKE_SOURCE_DIR}/doc/asciidoctor-macros/ws_utils.rb
         --require ${CMAKE_SOURCE_DIR}/doc/asciidoctor-macros/commaize-block.rb

cmake/modules/FindXSLTPROC.cmake

@@ -93,7 +93,7 @@ MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources)
         SET(_modeparams --stringparam chunker.output.encoding UTF-8 --stringparam chunk.quietly 1)
     ELSE() # single-page
         SET(_basedir ${_dir_pfx}_html)
-        SET(_stylesheet ${CMAKE_SOURCE_DIR}/docbook/custom_layer_single_html.xsl)
+        SET(_stylesheet ${CMAKE_SOURCE_DIR}/doc/custom_layer_single_html.xsl)
         SET(_modeparams --output ${_basedir}/index.html)
     ENDIF()
 

doc/CMakeLists.txt

@@ -180,6 +180,453 @@ if(ASCIIDOCTOR_FOUND)
 	)
 endif()
 
+#
+# Wireshark User's and Developer's Guides
+#
+
+set(COMMON_GUIDE_FILES
+	common_src/gpl_appendix.adoc
+	common_src/typographic_conventions.adoc
+)
+
+set(WSUG_TITLE "Wireshark User's Guide")
+
+set(WSUG_FILES
+	wsug_src/wsug_advanced.adoc
+	wsug_src/wsug_build_install.adoc
+	wsug_src/wsug_capture.adoc
+	wsug_src/wsug_customize.adoc
+	wsug_src/wsug_files.adoc
+	wsug_src/wsug_howitworks.adoc
+	wsug_src/wsug_introduction.adoc
+	wsug_src/wsug_io.adoc
+	wsug_src/wsug_mate.adoc
+	wsug_src/wsug_messages.adoc
+	wsug_src/wsug_preface.adoc
+	wsug_src/wsug_protocols.adoc
+	wsug_src/wsug_statistics.adoc
+	wsug_src/wsug_telephony.adoc
+	wsug_src/wsug_tools.adoc
+	wsug_src/wsug_troubleshoot.adoc
+	wsug_src/wsug_use.adoc
+	wsug_src/wsug_work.adoc
+	wsug_src/capinfos-h.txt
+	wsug_src/dumpcap-h.txt
+	wsug_src/editcap-F.txt
+	wsug_src/editcap-T.txt
+	wsug_src/editcap-h.txt
+	wsug_src/mergecap-h.txt
+	wsug_src/rawshark-h.txt
+	wsug_src/reordercap-h.txt
+	wsug_src/text2pcap-h.txt
+	wsug_src/tshark-h.txt
+	wsug_src/wireshark-h.txt
+	${COMMON_GUIDE_FILES}
+)
+
+# Note: Images should be minimized using tools/compress-pngs.py.
+set(WSUG_GRAPHICS
+	wsug_src/images/caution.svg
+	wsug_src/images/important.svg
+	wsug_src/images/note.svg
+	wsug_src/images/related-ack.png
+	wsug_src/images/related-current.png
+	wsug_src/images/related-dup-ack.png
+	wsug_src/images/related-first.png
+	wsug_src/images/related-last.png
+	wsug_src/images/related-other.png
+	wsug_src/images/related-request.png
+	wsug_src/images/related-response.png
+	wsug_src/images/related-segment.png
+	wsug_src/images/tip.svg
+	wsug_src/images/toolbar/document-open.png
+	wsug_src/images/toolbar/edit-find.png
+	wsug_src/images/toolbar/filter-toolbar-add.png
+	wsug_src/images/toolbar/filter-toolbar-apply.png
+	wsug_src/images/toolbar/filter-toolbar-bookmark.png
+	wsug_src/images/toolbar/filter-toolbar-clear.png
+	wsug_src/images/toolbar/filter-toolbar-input.png
+	wsug_src/images/toolbar/filter-toolbar-recent.png
+	wsug_src/images/toolbar/go-first.png
+	wsug_src/images/toolbar/go-jump.png
+	wsug_src/images/toolbar/go-last.png
+	wsug_src/images/toolbar/go-next.png
+	wsug_src/images/toolbar/go-previous.png
+	wsug_src/images/toolbar/x-capture-file-close.png
+	wsug_src/images/toolbar/x-capture-file-reload.png
+	wsug_src/images/toolbar/x-capture-file-save.png
+	wsug_src/images/toolbar/x-capture-options.png
+	wsug_src/images/toolbar/x-capture-restart.png
+	wsug_src/images/toolbar/x-capture-start.png
+	wsug_src/images/toolbar/x-capture-stop.png
+	wsug_src/images/toolbar/x-colorize-packets.png
+	wsug_src/images/toolbar/x-resize-columns.png
+	wsug_src/images/toolbar/x-stay-last.png
+	wsug_src/images/toolbar/zoom-in.png
+	wsug_src/images/toolbar/zoom-original.png
+	wsug_src/images/toolbar/zoom-out.png
+	wsug_src/images/warning.svg
+	wsug_src/images/ws-about-codecs.png
+	wsug_src/images/ws-analyze-menu.png
+	wsug_src/images/ws-bytes-pane-popup-menu.png
+	wsug_src/images/ws-bytes-pane-tabs.png
+	wsug_src/images/ws-bytes-pane.png
+	wsug_src/images/ws-capture-file-properties.png
+	wsug_src/images/ws-capture-info.png
+	wsug_src/images/ws-capture-interfaces-main-macos.png
+	wsug_src/images/ws-capture-interfaces-main-win32.png
+	wsug_src/images/ws-capture-menu.png
+	wsug_src/images/ws-capture-options-compile-selected-bpfs.png
+	wsug_src/images/ws-capture-options-options.png
+	wsug_src/images/ws-capture-options-output.png
+	wsug_src/images/ws-capture-options-output.png
+	wsug_src/images/ws-capture-options.png
+	wsug_src/images/ws-choose-color-rule.png
+	wsug_src/images/ws-coloring-fields.png
+	wsug_src/images/ws-coloring-rules-dialog.png
+	wsug_src/images/ws-column-header-popup-menu.png
+	wsug_src/images/ws-decode-as.png
+	wsug_src/images/ws-details-pane-popup-menu.png
+	wsug_src/images/ws-details-pane.png
+	wsug_src/images/ws-diagram-pane-popup-menu.png
+	wsug_src/images/ws-diagram-pane.png
+	wsug_src/images/ws-display-filter-tcp.png # GTK+
+	wsug_src/images/ws-edit-menu.png
+	wsug_src/images/ws-enabled-protocols.png
+	wsug_src/images/ws-expert-colored-tree.png
+	wsug_src/images/ws-expert-column.png
+	wsug_src/images/ws-expert-information.png
+	wsug_src/images/ws-export-objects.png
+	wsug_src/images/ws-export-packet-dissections.png
+	wsug_src/images/ws-export-selected.png
+	wsug_src/images/ws-export-specified-packets.png
+	wsug_src/images/ws-file-import.png
+	wsug_src/images/ws-file-menu.png
+	wsug_src/images/ws-file-set-dialog.png # GTK+
+	wsug_src/images/ws-filter-add-expression.png # GTK+
+	wsug_src/images/ws-filter-toolbar.png
+	wsug_src/images/ws-filters.png # GTK+
+	wsug_src/images/ws-find-packet.png
+	wsug_src/images/ws-follow-http2-stream.png
+	wsug_src/images/ws-follow-sip-stream.png
+	wsug_src/images/ws-follow-stream.png
+	wsug_src/images/ws-go-menu.png
+	wsug_src/images/ws-goto-packet.png
+	wsug_src/images/ws-help-menu.png
+	wsug_src/images/ws-list-pane.png # Outdated
+	wsug_src/images/ws-main-toolbar.png
+	wsug_src/images/ws-main.png
+	wsug_src/images/ws-manage-interfaces.png
+	wsug_src/images/ws-mate-analysis.png
+	wsug_src/images/ws-mate-dns_pane.png
+	wsug_src/images/ws-mate-dns_pdu.png
+	wsug_src/images/ws-mate-ftp_over_gre.png
+	wsug_src/images/ws-mate-gop_analysis.png
+	wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png
+	wsug_src/images/ws-mate-mmse_over_http.png
+	wsug_src/images/ws-mate-pdu_analysis.png
+	wsug_src/images/ws-mate-tcp-output.png
+	wsug_src/images/ws-mate-transform.png
+	wsug_src/images/ws-menu.png
+	wsug_src/images/ws-merge-qt5.png
+	wsug_src/images/ws-merge-win32.png
+	wsug_src/images/ws-open-qt5.png
+	wsug_src/images/ws-open-win32.png
+	wsug_src/images/ws-packet-format.png
+	wsug_src/images/ws-packet-pane-popup-menu.png
+	wsug_src/images/ws-packet-range.png
+	wsug_src/images/ws-packet-selected.png
+	wsug_src/images/ws-packet-sep-win.png
+	wsug_src/images/ws-pref-advanced.png
+	wsug_src/images/ws-pref-appearance-columns.png
+	wsug_src/images/ws-pref-appearance-fonts-and-colors.png
+	wsug_src/images/ws-pref-appearance-layout.png
+	wsug_src/images/ws-pref-appearance.png
+	wsug_src/images/ws-pref-capture.png
+	wsug_src/images/ws-pref-expert.png
+	wsug_src/images/ws-pref-filter-buttons.png
+	wsug_src/images/ws-pref-name-resolution.png
+	wsug_src/images/ws-pref-protocols.png
+	wsug_src/images/ws-pref-rsa-keys.png
+	wsug_src/images/ws-pref-statistics.png
+	wsug_src/images/ws-print.png
+	wsug_src/images/ws-save-as-qt5.png
+	wsug_src/images/ws-save-as-win32.png
+	wsug_src/images/ws-statistics-menu.png
+	wsug_src/images/ws-stats-conversations.png
+	wsug_src/images/ws-stats-endpoints.png
+	wsug_src/images/ws-stats-hierarchy.png
+	wsug_src/images/ws-stats-iographs.png
+	wsug_src/images/ws-stats-lte-mac-traffic.png
+	wsug_src/images/ws-stats-lte-rlc-traffic.png
+	wsug_src/images/ws-stats-packet-lengths.png
+	wsug_src/images/ws-stats-srt-smb2.png
+	wsug_src/images/ws-stats-wlan-traffic.png # GTK+
+	wsug_src/images/ws-statusbar-empty.png
+	wsug_src/images/ws-statusbar-filter.png
+	wsug_src/images/ws-statusbar-loaded.png
+	wsug_src/images/ws-statusbar-profile.png
+	wsug_src/images/ws-statusbar-selected.png
+	wsug_src/images/ws-tcp-analysis.png
+	wsug_src/images/ws-tel-playlist.png
+	wsug_src/images/ws-tel-rtp-player_1.png
+	wsug_src/images/ws-tel-rtp-player_2.png
+	wsug_src/images/ws-tel-rtp-player_3.png
+	wsug_src/images/ws-tel-rtp-player_button.png
+	wsug_src/images/ws-tel-rtp-streams.png
+	wsug_src/images/ws-tel-rtpstream-analysis_1.png
+	wsug_src/images/ws-tel-rtpstream-analysis_2.png
+	wsug_src/images/ws-tel-rtpstream-analysis_3.png
+	wsug_src/images/ws-tel-seq-dialog.png
+	wsug_src/images/ws-tel-voip-calls.png
+	wsug_src/images/ws-telephony-menu.png
+	wsug_src/images/ws-time-reference.png # GTK+
+	wsug_src/images/ws-tools-menu.png
+	wsug_src/images/ws-view-menu.png
+)
+
+set(WSDG_TITLE "Wireshark Developer's Guide")
+
+set(WSDG_FILES
+	wsdg_src/wsdg_asn2wrs.adoc
+	wsdg_src/wsdg_build_intro.adoc
+	wsdg_src/wsdg_capture.adoc
+	wsdg_src/wsdg_dissection.adoc
+	wsdg_src/wsdg_env_intro.adoc
+	wsdg_src/wsdg_libraries.adoc
+	wsdg_src/wsdg_lua_support.adoc
+	wsdg_src/wsdg_preface.adoc
+	wsdg_src/wsdg_quick_setup.adoc
+	wsdg_src/wsdg_sources.adoc
+	wsdg_src/wsdg_tests.adoc
+	wsdg_src/wsdg_tools.adoc
+	wsdg_src/wsdg_userinterface.adoc
+	wsdg_src/wsdg_works.adoc
+	${COMMON_GUIDE_FILES}
+)
+
+set(WSDG_GRAPHICS
+	wsdg_src/images/caution.svg
+	wsdg_src/images/git-triangular-workflow.gv
+	wsdg_src/images/git-triangular-workflow.svg
+	wsdg_src/images/important.svg
+	wsdg_src/images/note.svg
+	wsdg_src/images/tip.svg
+	wsdg_src/images/warning.svg
+	wsdg_src/images/ws-capture_internals.dia
+	wsdg_src/images/ws-capture_internals.png
+	wsdg_src/images/ws-capture-sync.dia
+	wsdg_src/images/ws-capture-sync.png
+	wsdg_src/images/ws-capture-sync.png
+	wsdg_src/images/ws-function-blocks.dia
+	wsdg_src/images/ws-function-blocks.svg
+	wsdg_src/images/ws-logo.png
+)
+
+set(WSUG_SOURCE
+	${WSUG_FILES}
+	${WSUG_GRAPHICS}
+)
+
+set(WSDG_SOURCE
+	${WSDG_FILES}
+	${WSDG_GRAPHICS}
+)
+
+# Note: file order here MATTERS!
+# new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE
+# files for the same module
+set(WSLUA_MODULES
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dumper.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_field.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_gui.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_int64.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_address.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_column.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_nstime.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dissector.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pref.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_expert.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_field.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_byte_array.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file_handler.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_frame_info.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_capture_info.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dir.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_wtap.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_utility.c
+	${CMAKE_SOURCE_DIR}/epan/wslua/wslua_struct.c
+)
+
+# Empty file to trigger wsluarm generation.
+ADD_CUSTOM_COMMAND(
+	OUTPUT
+		wsluarm
+	COMMAND ${CMAKE_COMMAND} -E make_directory wsluarm_src
+	COMMAND ${Python3_EXECUTABLE}
+		${CMAKE_SOURCE_DIR}/tools/make-wsluarm.py
+		--output-directory wsluarm_src
+		${WSLUA_MODULES}
+	COMMAND ${CMAKE_COMMAND} -E touch
+		wsluarm
+	DEPENDS
+		${CMAKE_SOURCE_DIR}/tools/make-wsluarm.py
+		${WSLUA_MODULES}
+)
+
+set( WSDG_BUILT_DEPS wsluarm )
+
+set( ASCIIDOC_CONF_FILES
+	${CMAKE_CURRENT_SOURCE_DIR}/attributes.adoc
+	# XXX Add macros
+)
+
+if(ASCIIDOCTOR_FOUND)
+	# Generate the DocBook sources of user and developer guides
+
+	ASCIIDOCTOR2DOCBOOK(wsug_src/user-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
+	add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml)
+	set_doc_target_properties(user_guide_docbook)
+
+	ASCIIDOCTOR2DOCBOOK(wsdg_src/developer-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
+	add_custom_target(developer_guide_docbook DEPENDS generate_developer-guide.xml)
+	set_doc_target_properties(developer_guide_docbook)
+
+	# Top-level guide targets.
+
+	add_custom_target(user_guides DEPENDS user_guide_docbook)
+	set_doc_target_properties(user_guides)
+
+	add_custom_target(developer_guides DEPENDS developer_guide_docbook)
+	set_doc_target_properties(developer_guides)
+
+	add_custom_target(all_guides DEPENDS user_guides developer_guides )
+	set_doc_target_properties(all_guides)
+endif()
+
+# User's Guide chain.
+if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
+	XML2HTML(
+		user_guide
+		wsug
+		single-page
+		user-guide.xml
+		WSUG_GRAPHICS
+	)
+
+	XML2HTML(
+		user_guide
+		wsug
+		chunked
+		user-guide.xml
+		WSUG_GRAPHICS
+	)
+	add_custom_target(
+		user_guide_html
+		DEPENDS
+			wsug_html/index.html
+			wsug_html_chunked/index.html
+	)
+	set_doc_target_properties(user_guide_html)
+	add_dependencies(user_guides user_guide_html)
+	# Copy the WSUG to the build directory so that when running
+	# from the build directory ui/help_url.c will find the local file.
+	# It expects the WSUG in a different directory on Windows.
+	if(WIN32)
+		set(WSUG_DIR "${DATAFILE_DIR}/${WSUG_TITLE}")
+	else()
+		set(WSUG_DIR "${DATAFILE_DIR}/wsug_html_chunked")
+	endif()
+	# CMake 3.26 has copy_directory_if_different
+	add_custom_command(
+		TARGET user_guide_html
+		COMMAND ${CMAKE_COMMAND} -E copy_directory
+			"${CMAKE_CURRENT_BINARY_DIR}/wsug_html_chunked" "${WSUG_DIR}"
+		VERBATIM
+	)
+endif()
+
+if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
+	ASCIIDOCTOR2PDF(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
+
+	add_custom_target(
+		user_guide_pdf
+		DEPENDS
+			"${WSUG_TITLE}.pdf"
+	)
+	set_doc_target_properties(user_guide_pdf)
+	add_dependencies(user_guides user_guide_pdf)
+endif()
+
+if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE)
+	ASCIIDOCTOR2EPUB(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
+
+	add_custom_target(
+		user_guide_epub
+		DEPENDS
+			"${WSUG_TITLE}.epub"
+	)
+	set_doc_target_properties(user_guide_epub)
+	add_dependencies(user_guides user_guide_epub)
+endif()
+
+# Developer's Guide chain.
+if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
+	XML2HTML(
+		developer_guide
+		wsdg
+		single-page
+		developer-guide.xml
+		WSDG_GRAPHICS
+	)
+
+	XML2HTML(
+		developer_guide
+		wsdg
+		chunked
+		developer-guide.xml
+		WSDG_GRAPHICS
+	)
+	add_custom_target(
+		developer_guide_html
+		DEPENDS
+			wsdg_html/index.html
+			wsdg_html_chunked/index.html
+	)
+	set_doc_target_properties(developer_guide_html)
+	add_dependencies(developer_guides developer_guide_html)
+endif()
+
+if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
+	ASCIIDOCTOR2PDF(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
+
+	add_custom_target(
+		developer_guide_pdf
+		DEPENDS
+			"${WSDG_TITLE}.pdf"
+	)
+	set_doc_target_properties(developer_guide_pdf)
+	add_dependencies(developer_guides developer_guide_pdf)
+endif()
+
+if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE)
+	ASCIIDOCTOR2EPUB(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
+
+	add_custom_target(
+		developer_guide_epub
+		DEPENDS
+			"${WSDG_TITLE}.epub"
+	)
+	set_doc_target_properties(developer_guide_epub)
+	add_dependencies(developer_guides developer_guide_epub)
+endif()
+
 #
 # Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 #

doc/README.documentation.adoc

@@ -93,44 +93,3 @@ _developer-guide.adoc_ include _attributes.adoc_. As a result,
 some markup will be incomplete. You can work around this somewhat by
 adding some attributes such as `compat-mode experimental` to your Live
 Preview settings.
-
-= HTML Help Alternatives
-
-Ideally we would ship documentation with Wireshark that is pleasant to
-read, browsable, and searchable. Unfortunately we don't have an easy way
-to do this. The closest we've been able to come is by shipping an HTML
-Help (.chm) file on Windows. However, HTML Help a) is limited to Windows,
-b) crusty on normal displays, and c) really crusty on HiDPI displays.
-
-The following alternative formats are available, each with advantages
-and disadvantages:
-
-== WebHelp
-
-https://en.wikipedia.org/wiki/Webhelp[WebHelp] has three main
-dependencies:
-
-- DocBook XSL, including...
-- webhelpindexer.jar
-- The user's local web browser
-
-This format generates both HTML pages and JavaScript, which might not run
-reliably on end user machines.
-
-== PDF
-
-PDF output is page oriented, with static page sizes. This _usually_ isn't
-a problem with modern reader software. However it doesn't look like we
-can reliably load a PDF file and jump to specific section on some
-platforms. For example, loading +++file:///path/to/user_guide.pdf#location+++
-works in Firefox & Chrome, but not in Safari, Preview, or Internet Explorer.
-
-== Qt Help
-
-Qt provides an extensive https://doc.qt.io/qt-5/qthelp-framework.html[help system].
-However, to use it we need to generate a Qt Help Project (.qhp) file,
-which isn't currently supported by Asciidoctor or via DocBook XSL.
-
-The default help application (Qt Assistant) is ugly. We'd probably want
-to write our own help viewer app or integrate help directly via
-QHelpEngine.

doc/README.wslua

@@ -45,8 +45,8 @@ Both of the scripts above are given the C-source files to search through
 by the make process, generated from the lists in epan/wslua/CMakeLists.txt.
 Naturally if you add new source files, you need to add them to the list in
 epan/wslua/CMakeLists.txt. You also have to add the module name into
-docbook/user-guide.xml and docbook/wsluarm.xml, and the source files into
-docbook/CMakeLists.txt, to get it to be generated in the user guide.
+doc/user-guide.xml and doc/wsluarm.xml, and the source files into
+doc/CMakeLists.txt, to get it to be generated in the user guide.
 
 Due to those documentation and registration scripts, you MUST follow some very
 specific conventions in the functions you write to expose C-side code to Lua,
@@ -286,14 +286,14 @@ from anything with a 'WSLUA_FUNCTION' macro (as opposed to class member
 functions, which use the 'WSLUA_METHOD' and 'WSLUA_CONSTRUCTOR' macros). Also,
 to make new wslua files generate documentation, it is not sufficient to just
 add this macro to a new file and add the file to the CMakeLists.txt; you also
-have to add the module name into docbook/user-guide.xml, and docbook/wsluarm.xml.
+have to add the module name into doc/user-guide.xml, and doc/wsluarm.xml.
 
 
 WSLUA_CONTINUE_MODULE - like WSLUA_MODULE, except used at the top of a .c file
 to continue defining classes/functions/etc. within a previously declared module
 in a previous file (i.e., one that used WSLUA_MODULE). The module name must match
 the original one, and the .c file must be listed after the original one in the
-CMakeLists.txt lists in the docbook directory.
+CMakeLists.txt lists in the doc directory.
 
 
 WSLUA_ATTRIBUTE - this is another documentation-only "macro", only used within

doc/wsdg_src/images/git-triangular-workflow.gv

@@ -1,4 +1,4 @@
-// dot -Tsvg -o docbook/wsdg_graphics/git-triangular-workflow.svg docbook/wsdg_graphics/git-triangular-workflow.gv
+// dot -Tsvg -o doc/wsdg_graphics/git-triangular-workflow.svg doc/wsdg_graphics/git-triangular-workflow.gv
 
 digraph G {
     // XXX Integrate ws.css. Match it manually for now.

doc/wsdg_src/wsdg_quick_setup.adoc

@@ -224,7 +224,7 @@ to run it by entering `wireshark`.
 To build the Wireshark User's Guide and the Wireshark Developer's Guide,
 build the `all_guides` target, e.g.  `make all_guides` or `ninja
 all_guides`.  Detailed information to build these guides can be found in
-the file _docbook/README.adoc_ in the Wireshark sources.
+the file _doc/README.documentation.adoc_ in the Wireshark sources.
 
 ==== Optional: Create an installable or source code package
 
@@ -734,7 +734,7 @@ on using the <<ChToolsDebugger, Debugger Tools>>.
 To build the Wireshark User's Guide and the Wireshark Developer's Guide,
 build the `all_guides` target, e.g.  `msbuild all_guides.vcxproj`.
 Detailed information to build these guides can be found in the file
-_docbook\README.adoc_ in the Wireshark sources.
+_doc\README.adoc_ in the Wireshark sources.
 
 ==== Optional: Create a Wireshark Installer
 

doc/wsdg_src/wsdg_sources.adoc

@@ -958,8 +958,8 @@ $ git cherry-pick -x 1ab2c3d4
 $ ninja
 $ ...
 
-# OPTIONAL: Add entries to docbook/release-notes.adoc.
-$EDITOR docbook/release-notes.adoc
+# OPTIONAL: Add entries to doc/release-notes.adoc.
+$EDITOR doc/release-notes.adoc
 
 # If you made any changes, update your commit.
 git commit --amend -a

doc/wsdg_src/wsdg_tools.adoc

@@ -487,9 +487,7 @@ Edition, it will include an SDK.
 === Documentation Toolchain
 
 Wireshark’s documentation is split across two directories.
-The `doc` directory contains man pages written in Asciidoctor markup.
-The `docbook` directory contains the User’s Guide, Developer’s Guide, and the release notes, which are also written in Asciidoctor markup.
-The split is for historical reasons (described below), and the documentation will likely be consolidated into one directory in the future.
+The `doc` directory contains man pages, User’s Guide, Developer’s Guide, and the release notes, which are written in Asciidoctor markup.
 
 Our various output formats are generated using the following tools.
 Intermediate formats are in _italics_.