Docbook: Reorganize our guide directories

Move the top-level user-guide.adoc and developer-guide.adoc to their
respective source directores. This is in preparation for a future
toolchain revamp.

Move the wsug_graphics directory to wsug_src/images and wsdg_graphics
directory to wsdg_src/images. Copy common_graphics/* to the each images
directory and remove common_graphics. We only have five admonition
graphics; duplicating them lets us remove some build config overhead.

Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc.

Remove a dummy file.

Tested visually and by enabling `--failure-level=WARN`.
This commit is contained in:
Gerald Combs 2023-02-10 16:11:20 -08:00
parent dedad3403a
commit 53b2994b43
215 changed files with 468 additions and 446 deletions

View File

@ -105,27 +105,21 @@ MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources)
set(_gfx_deps ${CMAKE_CURRENT_SOURCE_DIR}/${_tmpgfx}) set(_gfx_deps ${CMAKE_CURRENT_SOURCE_DIR}/${_tmpgfx})
ENDFOREACH() ENDFOREACH()
SET(_gfx_dir ${_dir_pfx}_graphics) SET(_gfx_src_dir ${_dir_pfx}_src/images)
ADD_CUSTOM_COMMAND( ADD_CUSTOM_COMMAND(
OUTPUT OUTPUT
${_output} ${_output}
COMMAND ${CMAKE_COMMAND} COMMAND ${CMAKE_COMMAND}
-E make_directory ${_out_dir} -E make_directory ${_out_dir}
COMMAND ${CMAKE_COMMAND} COMMAND ${CMAKE_COMMAND}
-E make_directory ${_out_dir}/${_gfx_dir}/toolbar -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/${_gfx_src_dir} ${_out_dir}/images
COMMAND ${CMAKE_COMMAND}
-E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/${_gfx_dir} ${_out_dir}/${_gfx_dir}
COMMAND ${CMAKE_COMMAND}
-E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/common_graphics ${_out_dir}/${_gfx_dir}
COMMAND ${CMAKE_COMMAND}
-E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/${_gfx_dir}/toolbar ${_out_dir}/${_gfx_dir}/toolbar
COMMAND ${CMAKE_COMMAND} COMMAND ${CMAKE_COMMAND}
-E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/ws.css ${_out_dir} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/ws.css ${_out_dir}
COMMAND ${XSLTPROC_EXECUTABLE} COMMAND ${XSLTPROC_EXECUTABLE}
--path "${_xsltproc_path}" --path "${_xsltproc_path}"
--stringparam base.dir ${_basedir}/ --stringparam base.dir ${_basedir}/
${_common_xsltproc_args} ${_common_xsltproc_args}
--stringparam admon.graphics.path ${_gfx_dir}/ --stringparam admon.graphics.path images/
${_modeparams} ${_modeparams}
--noout ${_stylesheet} --noout ${_stylesheet}
${_dbk_source} ${_dbk_source}
@ -135,6 +129,17 @@ MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources)
${_gfx_deps} ${_gfx_deps}
custom_layer_single_html.xsl custom_layer_single_html.xsl
) )
if(${_dir_pfx} STREQUAL wsug)
ADD_CUSTOM_COMMAND(
OUTPUT
${_output}
COMMAND ${CMAKE_COMMAND}
-E make_directory ${_out_dir}/images/toolbar
COMMAND ${CMAKE_COMMAND}
-E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/${_gfx_src_dir}/toolbar ${_out_dir}/images/toolbar
APPEND
)
endif()
IF(NOT WIN32) IF(NOT WIN32)
ADD_CUSTOM_COMMAND( ADD_CUSTOM_COMMAND(
OUTPUT OUTPUT

View File

@ -26,14 +26,6 @@ set(COMMON_FILES
common_src/typographic_conventions.adoc common_src/typographic_conventions.adoc
) )
set(COMMON_GRAPHICS
common_graphics/caution.svg
common_graphics/important.svg
common_graphics/note.svg
common_graphics/tip.svg
common_graphics/warning.svg
)
set(GUIDE_INSTALL_DIRS) set(GUIDE_INSTALL_DIRS)
set(WSUG_TITLE "Wireshark User's Guide") set(WSUG_TITLE "Wireshark User's Guide")
@ -73,149 +65,153 @@ set(WSUG_FILES
# Note: Images should be minimized using tools/compress-pngs.py. # Note: Images should be minimized using tools/compress-pngs.py.
set(WSUG_GRAPHICS set(WSUG_GRAPHICS
wsug_graphics/related-ack.png wsug_src/images/caution.svg
wsug_graphics/related-current.png wsug_src/images/important.svg
wsug_graphics/related-dup-ack.png wsug_src/images/note.svg
wsug_graphics/related-first.png wsug_src/images/related-ack.png
wsug_graphics/related-last.png wsug_src/images/related-current.png
wsug_graphics/related-other.png wsug_src/images/related-dup-ack.png
wsug_graphics/related-request.png wsug_src/images/related-first.png
wsug_graphics/related-response.png wsug_src/images/related-last.png
wsug_graphics/related-segment.png wsug_src/images/related-other.png
wsug_graphics/ws-about-codecs.png wsug_src/images/related-request.png
wsug_graphics/ws-analyze-menu.png wsug_src/images/related-response.png
wsug_graphics/ws-bytes-pane-popup-menu.png wsug_src/images/related-segment.png
wsug_graphics/ws-bytes-pane-tabs.png wsug_src/images/tip.svg
wsug_graphics/ws-bytes-pane.png wsug_src/images/toolbar/document-open.png
wsug_graphics/ws-capture-file-properties.png wsug_src/images/toolbar/edit-find.png
wsug_graphics/ws-capture-info.png wsug_src/images/toolbar/filter-toolbar-add.png
wsug_graphics/ws-capture-interfaces-main-macos.png wsug_src/images/toolbar/filter-toolbar-apply.png
wsug_graphics/ws-capture-interfaces-main-win32.png wsug_src/images/toolbar/filter-toolbar-bookmark.png
wsug_graphics/ws-capture-menu.png wsug_src/images/toolbar/filter-toolbar-clear.png
wsug_graphics/ws-capture-options.png wsug_src/images/toolbar/filter-toolbar-input.png
wsug_graphics/ws-capture-options-output.png wsug_src/images/toolbar/filter-toolbar-recent.png
wsug_graphics/ws-capture-options-options.png wsug_src/images/toolbar/go-first.png
wsug_graphics/ws-capture-options-compile-selected-bpfs.png wsug_src/images/toolbar/go-jump.png
wsug_graphics/ws-capture-options-output.png wsug_src/images/toolbar/go-last.png
wsug_graphics/ws-choose-color-rule.png wsug_src/images/toolbar/go-next.png
wsug_graphics/ws-coloring-fields.png wsug_src/images/toolbar/go-previous.png
wsug_graphics/ws-coloring-rules-dialog.png wsug_src/images/toolbar/x-capture-file-close.png
wsug_graphics/ws-column-header-popup-menu.png wsug_src/images/toolbar/x-capture-file-reload.png
wsug_graphics/ws-decode-as.png wsug_src/images/toolbar/x-capture-file-save.png
wsug_graphics/ws-details-pane-popup-menu.png wsug_src/images/toolbar/x-capture-options.png
wsug_graphics/ws-details-pane.png wsug_src/images/toolbar/x-capture-restart.png
wsug_graphics/ws-diagram-pane.png wsug_src/images/toolbar/x-capture-start.png
wsug_graphics/ws-diagram-pane-popup-menu.png wsug_src/images/toolbar/x-capture-stop.png
wsug_graphics/ws-display-filter-tcp.png # GTK+ wsug_src/images/toolbar/x-colorize-packets.png
wsug_graphics/ws-edit-menu.png wsug_src/images/toolbar/x-resize-columns.png
wsug_graphics/ws-enabled-protocols.png wsug_src/images/toolbar/x-stay-last.png
wsug_graphics/ws-expert-colored-tree.png wsug_src/images/toolbar/zoom-in.png
wsug_graphics/ws-expert-column.png wsug_src/images/toolbar/zoom-original.png
wsug_graphics/ws-expert-information.png wsug_src/images/toolbar/zoom-out.png
wsug_graphics/ws-export-objects.png wsug_src/images/warning.svg
wsug_graphics/ws-export-packet-dissections.png wsug_src/images/ws-about-codecs.png
wsug_graphics/ws-export-specified-packets.png wsug_src/images/ws-analyze-menu.png
wsug_graphics/ws-export-selected.png wsug_src/images/ws-bytes-pane-popup-menu.png
wsug_graphics/ws-file-import.png wsug_src/images/ws-bytes-pane-tabs.png
wsug_graphics/ws-file-menu.png wsug_src/images/ws-bytes-pane.png
wsug_graphics/ws-file-set-dialog.png # GTK+ wsug_src/images/ws-capture-file-properties.png
wsug_graphics/ws-filter-add-expression.png # GTK+ wsug_src/images/ws-capture-info.png
wsug_graphics/ws-filter-toolbar.png wsug_src/images/ws-capture-interfaces-main-macos.png
wsug_graphics/ws-filters.png # GTK+ wsug_src/images/ws-capture-interfaces-main-win32.png
wsug_graphics/ws-find-packet.png wsug_src/images/ws-capture-menu.png
wsug_graphics/ws-follow-sip-stream.png wsug_src/images/ws-capture-options-compile-selected-bpfs.png
wsug_graphics/ws-follow-stream.png wsug_src/images/ws-capture-options-options.png
wsug_graphics/ws-follow-http2-stream.png wsug_src/images/ws-capture-options-output.png
wsug_graphics/ws-go-menu.png wsug_src/images/ws-capture-options-output.png
wsug_graphics/ws-goto-packet.png wsug_src/images/ws-capture-options.png
wsug_graphics/ws-gui-preferences.png wsug_src/images/ws-choose-color-rule.png
wsug_graphics/ws-gui-preferences-advanced.png wsug_src/images/ws-coloring-fields.png
wsug_graphics/ws-help-menu.png wsug_src/images/ws-coloring-rules-dialog.png
wsug_graphics/ws-list-pane.png # Outdated wsug_src/images/ws-column-header-popup-menu.png
wsug_graphics/ws-main-toolbar.png wsug_src/images/ws-decode-as.png
wsug_graphics/ws-main.png wsug_src/images/ws-details-pane-popup-menu.png
wsug_graphics/ws-manage-interfaces.png wsug_src/images/ws-details-pane.png
wsug_graphics/ws-mate-analysis.png wsug_src/images/ws-diagram-pane-popup-menu.png
wsug_graphics/ws-mate-dns_pane.png wsug_src/images/ws-diagram-pane.png
wsug_graphics/ws-mate-dns_pdu.png wsug_src/images/ws-display-filter-tcp.png # GTK+
wsug_graphics/ws-mate-ftp_over_gre.png wsug_src/images/ws-edit-menu.png
wsug_graphics/ws-mate-gop_analysis.png wsug_src/images/ws-enabled-protocols.png
wsug_graphics/ws-mate-isup_over_mtp3_over_ip.png wsug_src/images/ws-expert-colored-tree.png
wsug_graphics/ws-mate-mmse_over_http.png wsug_src/images/ws-expert-column.png
wsug_graphics/ws-mate-pdu_analysis.png wsug_src/images/ws-expert-information.png
wsug_graphics/ws-mate-tcp-output.png wsug_src/images/ws-export-objects.png
wsug_graphics/ws-mate-transform.png wsug_src/images/ws-export-packet-dissections.png
wsug_graphics/ws-menu.png wsug_src/images/ws-export-selected.png
wsug_graphics/ws-merge-qt5.png wsug_src/images/ws-export-specified-packets.png
wsug_graphics/ws-merge-win32.png wsug_src/images/ws-file-import.png
wsug_graphics/ws-open-qt5.png wsug_src/images/ws-file-menu.png
wsug_graphics/ws-open-win32.png wsug_src/images/ws-file-set-dialog.png # GTK+
wsug_graphics/ws-packet-format.png wsug_src/images/ws-filter-add-expression.png # GTK+
wsug_graphics/ws-packet-pane-popup-menu.png wsug_src/images/ws-filter-toolbar.png
wsug_graphics/ws-packet-range.png wsug_src/images/ws-filters.png # GTK+
wsug_graphics/ws-packet-selected.png wsug_src/images/ws-find-packet.png
wsug_graphics/ws-packet-sep-win.png wsug_src/images/ws-follow-http2-stream.png
wsug_graphics/ws-print.png wsug_src/images/ws-follow-sip-stream.png
wsug_graphics/ws-save-as-qt5.png wsug_src/images/ws-follow-stream.png
wsug_graphics/ws-save-as-win32.png wsug_src/images/ws-go-menu.png
wsug_graphics/ws-statistics-menu.png wsug_src/images/ws-goto-packet.png
wsug_graphics/ws-stats-conversations.png wsug_src/images/ws-gui-preferences-advanced.png
wsug_graphics/ws-stats-endpoints.png wsug_src/images/ws-gui-preferences.png
wsug_graphics/ws-stats-hierarchy.png wsug_src/images/ws-help-menu.png
wsug_graphics/ws-stats-iographs.png wsug_src/images/ws-list-pane.png # Outdated
wsug_graphics/ws-stats-packet-lengths.png wsug_src/images/ws-main-toolbar.png
wsug_graphics/ws-stats-srt-smb2.png wsug_src/images/ws-main.png
wsug_graphics/ws-stats-lte-mac-traffic.png wsug_src/images/ws-manage-interfaces.png
wsug_graphics/ws-stats-lte-rlc-traffic.png wsug_src/images/ws-mate-analysis.png
wsug_graphics/ws-stats-wlan-traffic.png # GTK+ wsug_src/images/ws-mate-dns_pane.png
wsug_graphics/ws-statusbar-empty.png wsug_src/images/ws-mate-dns_pdu.png
wsug_graphics/ws-statusbar-filter.png wsug_src/images/ws-mate-ftp_over_gre.png
wsug_graphics/ws-statusbar-loaded.png wsug_src/images/ws-mate-gop_analysis.png
wsug_graphics/ws-statusbar-profile.png wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png
wsug_graphics/ws-statusbar-selected.png wsug_src/images/ws-mate-mmse_over_http.png
wsug_graphics/ws-tcp-analysis.png wsug_src/images/ws-mate-pdu_analysis.png
wsug_graphics/ws-tel-playlist.png wsug_src/images/ws-mate-tcp-output.png
wsug_graphics/ws-tel-rtp-player_1.png wsug_src/images/ws-mate-transform.png
wsug_graphics/ws-tel-rtp-player_2.png wsug_src/images/ws-menu.png
wsug_graphics/ws-tel-rtp-player_3.png wsug_src/images/ws-merge-qt5.png
wsug_graphics/ws-tel-rtp-player_button.png wsug_src/images/ws-merge-win32.png
wsug_graphics/ws-tel-rtp-streams.png wsug_src/images/ws-open-qt5.png
wsug_graphics/ws-tel-rtpstream-analysis_1.png wsug_src/images/ws-open-win32.png
wsug_graphics/ws-tel-rtpstream-analysis_2.png wsug_src/images/ws-packet-format.png
wsug_graphics/ws-tel-rtpstream-analysis_3.png wsug_src/images/ws-packet-pane-popup-menu.png
wsug_graphics/ws-tel-seq-dialog.png wsug_src/images/ws-packet-range.png
wsug_graphics/ws-tel-voip-calls.png wsug_src/images/ws-packet-selected.png
wsug_graphics/ws-telephony-menu.png wsug_src/images/ws-packet-sep-win.png
wsug_graphics/ws-time-reference.png # GTK+ wsug_src/images/ws-print.png
wsug_graphics/ws-tools-menu.png wsug_src/images/ws-save-as-qt5.png
wsug_graphics/ws-view-menu.png wsug_src/images/ws-save-as-win32.png
wsug_graphics/toolbar/document-open.png wsug_src/images/ws-statistics-menu.png
wsug_graphics/toolbar/edit-find.png wsug_src/images/ws-stats-conversations.png
wsug_graphics/toolbar/filter-toolbar-add.png wsug_src/images/ws-stats-endpoints.png
wsug_graphics/toolbar/filter-toolbar-apply.png wsug_src/images/ws-stats-hierarchy.png
wsug_graphics/toolbar/filter-toolbar-bookmark.png wsug_src/images/ws-stats-iographs.png
wsug_graphics/toolbar/filter-toolbar-clear.png wsug_src/images/ws-stats-lte-mac-traffic.png
wsug_graphics/toolbar/filter-toolbar-input.png wsug_src/images/ws-stats-lte-rlc-traffic.png
wsug_graphics/toolbar/filter-toolbar-recent.png wsug_src/images/ws-stats-packet-lengths.png
wsug_graphics/toolbar/go-first.png wsug_src/images/ws-stats-srt-smb2.png
wsug_graphics/toolbar/go-jump.png wsug_src/images/ws-stats-wlan-traffic.png # GTK+
wsug_graphics/toolbar/go-last.png wsug_src/images/ws-statusbar-empty.png
wsug_graphics/toolbar/go-next.png wsug_src/images/ws-statusbar-filter.png
wsug_graphics/toolbar/go-previous.png wsug_src/images/ws-statusbar-loaded.png
wsug_graphics/toolbar/x-capture-file-close.png wsug_src/images/ws-statusbar-profile.png
wsug_graphics/toolbar/x-capture-file-reload.png wsug_src/images/ws-statusbar-selected.png
wsug_graphics/toolbar/x-capture-file-save.png wsug_src/images/ws-tcp-analysis.png
wsug_graphics/toolbar/x-capture-options.png wsug_src/images/ws-tel-playlist.png
wsug_graphics/toolbar/x-capture-restart.png wsug_src/images/ws-tel-rtp-player_1.png
wsug_graphics/toolbar/x-capture-start.png wsug_src/images/ws-tel-rtp-player_2.png
wsug_graphics/toolbar/x-capture-stop.png wsug_src/images/ws-tel-rtp-player_3.png
wsug_graphics/toolbar/x-colorize-packets.png wsug_src/images/ws-tel-rtp-player_button.png
wsug_graphics/toolbar/x-resize-columns.png wsug_src/images/ws-tel-rtp-streams.png
wsug_graphics/toolbar/x-stay-last.png wsug_src/images/ws-tel-rtpstream-analysis_1.png
wsug_graphics/toolbar/zoom-in.png wsug_src/images/ws-tel-rtpstream-analysis_2.png
wsug_graphics/toolbar/zoom-original.png wsug_src/images/ws-tel-rtpstream-analysis_3.png
wsug_graphics/toolbar/zoom-out.png wsug_src/images/ws-tel-seq-dialog.png
${COMMON_GRAPHICS} 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_TITLE "Wireshark Developer's Guide")
@ -227,29 +223,33 @@ set(WSDG_FILES
wsdg_src/wsdg_dissection.adoc wsdg_src/wsdg_dissection.adoc
wsdg_src/wsdg_env_intro.adoc wsdg_src/wsdg_env_intro.adoc
wsdg_src/wsdg_libraries.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_quick_setup.adoc
wsdg_src/wsdg_sources.adoc wsdg_src/wsdg_sources.adoc
wsdg_src/wsdg_tests.adoc wsdg_src/wsdg_tests.adoc
wsdg_src/wsdg_tools.adoc wsdg_src/wsdg_tools.adoc
wsdg_src/wsdg_userinterface.adoc wsdg_src/wsdg_userinterface.adoc
wsdg_src/wsdg_works.adoc wsdg_src/wsdg_works.adoc
wsdg_src/wsdg_preface.adoc
wsluarm.adoc
${COMMON_FILES} ${COMMON_FILES}
) )
set(WSDG_GRAPHICS set(WSDG_GRAPHICS
wsdg_graphics/git-triangular-workflow.gv wsdg_src/images/caution.svg
wsdg_graphics/git-triangular-workflow.svg wsdg_src/images/git-triangular-workflow.gv
wsdg_graphics/ws-capture-sync.png wsdg_src/images/git-triangular-workflow.svg
wsdg_graphics/ws-capture-sync.dia wsdg_src/images/important.svg
wsdg_graphics/ws-capture-sync.png wsdg_src/images/note.svg
wsdg_graphics/ws-capture_internals.dia wsdg_src/images/tip.svg
wsdg_graphics/ws-capture_internals.png wsdg_src/images/warning.svg
wsdg_graphics/ws-function-blocks.dia wsdg_src/images/ws-capture_internals.dia
wsdg_graphics/ws-function-blocks.png wsdg_src/images/ws-capture_internals.png
wsdg_graphics/ws-logo.png wsdg_src/images/ws-capture-sync.dia
${COMMON_GRAPHICS} 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.png
wsdg_src/images/ws-logo.png
) )
set(WSUG_SOURCE set(WSUG_SOURCE
@ -336,11 +336,11 @@ set( ASCIIDOC_CONF_FILES
if(ASCIIDOCTOR_FOUND) if(ASCIIDOCTOR_FOUND)
# Generate the DocBook sources of user and developer guides # Generate the DocBook sources of user and developer guides
ASCIIDOCTOR2DOCBOOK(user-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) 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) add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml)
set_docbook_target_properties(user_guide_docbook) set_docbook_target_properties(user_guide_docbook)
ASCIIDOCTOR2DOCBOOK(developer-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) 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) add_custom_target(developer_guide_docbook DEPENDS generate_developer-guide.xml)
set_docbook_target_properties(developer_guide_docbook) set_docbook_target_properties(developer_guide_docbook)
@ -385,7 +385,7 @@ if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
endif() endif()
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE) if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
ASCIIDOCTOR2PDF(${WSUG_TITLE} user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) ASCIIDOCTOR2PDF(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
add_custom_target( add_custom_target(
user_guide_pdf user_guide_pdf
@ -397,7 +397,7 @@ if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
endif() endif()
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE) if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE)
ASCIIDOCTOR2EPUB(${WSUG_TITLE} user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) ASCIIDOCTOR2EPUB(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
add_custom_target( add_custom_target(
user_guide_epub user_guide_epub
@ -437,7 +437,7 @@ if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
endif() endif()
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE) if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
ASCIIDOCTOR2PDF(${WSDG_TITLE} developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) ASCIIDOCTOR2PDF(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
add_custom_target( add_custom_target(
developer_guide_pdf developer_guide_pdf
@ -449,7 +449,7 @@ if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
endif() endif()
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE) if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE)
ASCIIDOCTOR2EPUB(${WSDG_TITLE} developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) ASCIIDOCTOR2EPUB(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
add_custom_target( add_custom_target(
developer_guide_epub developer_guide_epub

View File

@ -1,64 +0,0 @@
:doctype: book
include::attributes.adoc[]
// Electronic book attributes
:author: Richard Sharpe, Ed Warnicke, Ulf Lamping
:description: Wireshark Users Guide
:keywords: Wireshark User Guide
ifdef::ebook-format-epub3[]
:front-cover-image: wsug_graphics/ws-user-guide-cover.png
:toc:
endif::[]
= Wireshark Users Guide: Version {wireshark-version}
:source-highlighter: coderay
include::wsug_src/wsug_preface.adoc[]
include::common_src/typographic_conventions.adoc[]
// Chapters
include::wsug_src/wsug_introduction.adoc[]
include::wsug_src/wsug_build_install.adoc[]
include::wsug_src/wsug_use.adoc[]
include::wsug_src/wsug_capture.adoc[]
include::wsug_src/wsug_io.adoc[]
include::wsug_src/wsug_work.adoc[]
include::wsug_src/wsug_advanced.adoc[]
include::wsug_src/wsug_statistics.adoc[]
include::wsug_src/wsug_telephony.adoc[]
include::wsug_src/wsug_wireless.adoc[]
include::wsug_src/wsug_customize.adoc[]
include::wsug_src/wsug_mate.adoc[]
// Needs to be reworked
//include::wsug_src/wsug_troubleshoot.adoc[]
// Appendices
include::wsug_src/wsug_messages.adoc[]
include::wsug_src/wsug_files.adoc[]
include::wsug_src/wsug_protocols.adoc[]
// Needs to be reworked
//include::wsug_src/wsug_howitworks.adoc[]
include::wsug_src/wsug_tools.adoc[]
// License
include::common_src/gpl_appendix.adoc[]

View File

@ -1,12 +1,12 @@
:doctype: book :doctype: book
include::attributes.adoc[] include::../attributes.adoc[]
// Electronic book attributes // Electronic book attributes
:author: Ulf Lamping, Graham Bloice :author: Ulf Lamping, Graham Bloice
:description: Wireshark Developers Guide :description: Wireshark Developers Guide
:keywords: Wireshark Developer Guide :keywords: Wireshark Developer Guide
ifdef::ebook-format-epub3[] ifdef::ebook-format-epub3[]
:front-cover-image: wsdg_graphics/ws-dev-guide-cover.png :front-cover-image: images/ws-dev-guide-cover.png
:toc: :toc:
endif::[] endif::[]
@ -19,9 +19,9 @@ endif::[]
:qt6-lts-version: 6.2.4 :qt6-lts-version: 6.2.4
:source-highlighter: coderay :source-highlighter: coderay
include::wsdg_src/wsdg_preface.adoc[] include::wsdg_preface.adoc[]
include::common_src/typographic_conventions.adoc[] include::../common_src/typographic_conventions.adoc[]
[#PartEnvironment] [#PartEnvironment]
= Wireshark Build Environment = Wireshark Build Environment
@ -33,15 +33,15 @@ The first part describes how to set up the tools, libraries and source needed to
generate Wireshark and how to do some typical development tasks. generate Wireshark and how to do some typical development tasks.
-- --
include::wsdg_src/wsdg_env_intro.adoc[] include::wsdg_env_intro.adoc[]
include::wsdg_src/wsdg_quick_setup.adoc[] include::wsdg_quick_setup.adoc[]
include::wsdg_src/wsdg_sources.adoc[] include::wsdg_sources.adoc[]
include::wsdg_src/wsdg_tools.adoc[] include::wsdg_tools.adoc[]
include::wsdg_src/wsdg_libraries.adoc[] include::wsdg_libraries.adoc[]
[#PartDevelopment] [#PartDevelopment]
= Wireshark Development = Wireshark Development
@ -53,20 +53,20 @@ The second part describes how the Wireshark sources are structured and how to
change the sources such as adding a new dissector. change the sources such as adding a new dissector.
-- --
include::wsdg_src/wsdg_works.adoc[] include::wsdg_works.adoc[]
include::wsdg_src/wsdg_build_intro.adoc[] include::wsdg_build_intro.adoc[]
include::wsdg_src/wsdg_capture.adoc[] include::wsdg_capture.adoc[]
include::wsdg_src/wsdg_dissection.adoc[] include::wsdg_dissection.adoc[]
include::wsluarm.adoc[] include::wsdg_lua_support.adoc[]
include::wsdg_src/wsdg_userinterface.adoc[] include::wsdg_userinterface.adoc[]
include::wsdg_src/wsdg_tests.adoc[] include::wsdg_tests.adoc[]
include::wsdg_src/wsdg_asn2wrs.adoc[] include::wsdg_asn2wrs.adoc[]
include::common_src/gpl_appendix.adoc[] include::../common_src/gpl_appendix.adoc[]

View File

Before

Width:  |  Height:  |  Size: 405 B

After

Width:  |  Height:  |  Size: 405 B

View File

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 3.9 KiB

View File

Before

Width:  |  Height:  |  Size: 355 B

After

Width:  |  Height:  |  Size: 355 B

View File

Before

Width:  |  Height:  |  Size: 434 B

After

Width:  |  Height:  |  Size: 434 B

View File

Before

Width:  |  Height:  |  Size: 556 B

After

Width:  |  Height:  |  Size: 556 B

View File

Before

Width:  |  Height:  |  Size: 685 B

After

Width:  |  Height:  |  Size: 685 B

View File

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 5.4 KiB

View File

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -1,7 +1,7 @@
[#wsluarm] [#wsluarm]
// Attributes // Attributes
:build_dir: . :build_dir: ..
== Lua Support in Wireshark == Lua Support in Wireshark

View File

@ -363,7 +363,7 @@ This requires you to set up git as described at <<ChSrcGit>>.
GitLab uses a https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html[forking workflow], which looks like this: GitLab uses a https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html[forking workflow], which looks like this:
.GitLab Workflow .GitLab Workflow
image::wsdg_graphics/git-triangular-workflow.svg[] image::images/git-triangular-workflow.svg[]
In the diagram above, your fork can created by pressing the “Fork” button at {wireshark-gitlab-project-url}. In the diagram above, your fork can created by pressing the “Fork” button at {wireshark-gitlab-project-url}.
Your local repository can be created as described in <<ChSrcGit>>. Your local repository can be created as described in <<ChSrcGit>>.

View File

@ -19,7 +19,7 @@ The following will give you a simplified overview of Wiresharks function bloc
[#ChWorksFigOverview] [#ChWorksFigOverview]
.Wireshark function blocks .Wireshark function blocks
image::wsdg_graphics/ws-function-blocks.png[{pdf-scaledwidth}] image::images/ws-function-blocks.png[{pdf-scaledwidth}]
The function blocks in more detail: The function blocks in more detail:

View File

@ -0,0 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-lightning-charge" viewBox="0 0 16 16">
<path d="M11.251.068a.5.5 0 0 1 .227.58L9.677 6.5H13a.5.5 0 0 1 .364.843l-8 8.5a.5.5 0 0 1-.842-.49L6.323 9.5H3a.5.5 0 0 1-.364-.843l8-8.5a.5.5 0 0 1 .615-.09zM4.157 8.5H7a.5.5 0 0 1 .478.647L6.11 13.59l5.732-6.09H9a.5.5 0 0 1-.478-.647L9.89 2.41 4.157 8.5z"/>
</svg>

After

Width:  |  Height:  |  Size: 405 B

View File

@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-exclamation-circle" viewBox="0 0 16 16">
<path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z"/>
<path d="M7.002 11a1 1 0 1 1 2 0 1 1 0 0 1-2 0zM7.1 4.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 4.995z"/>
</svg>

After

Width:  |  Height:  |  Size: 355 B

View File

@ -0,0 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-sticky" viewBox="0 0 16 16">
<path d="M2.5 1A1.5 1.5 0 0 0 1 2.5v11A1.5 1.5 0 0 0 2.5 15h6.086a1.5 1.5 0 0 0 1.06-.44l4.915-4.914A1.5 1.5 0 0 0 15 8.586V2.5A1.5 1.5 0 0 0 13.5 1h-11zM2 2.5a.5.5 0 0 1 .5-.5h11a.5.5 0 0 1 .5.5V8H9.5A1.5 1.5 0 0 0 8 9.5V14H2.5a.5.5 0 0 1-.5-.5v-11zm7 11.293V9.5a.5.5 0 0 1 .5-.5h4.293L9 13.793z"/>
</svg>

After

Width:  |  Height:  |  Size: 434 B

View File

Before

Width:  |  Height:  |  Size: 221 B

After

Width:  |  Height:  |  Size: 221 B

View File

Before

Width:  |  Height:  |  Size: 92 B

After

Width:  |  Height:  |  Size: 92 B

View File

Before

Width:  |  Height:  |  Size: 247 B

After

Width:  |  Height:  |  Size: 247 B

View File

Before

Width:  |  Height:  |  Size: 105 B

After

Width:  |  Height:  |  Size: 105 B

View File

Before

Width:  |  Height:  |  Size: 105 B

After

Width:  |  Height:  |  Size: 105 B

View File

Before

Width:  |  Height:  |  Size: 99 B

After

Width:  |  Height:  |  Size: 99 B

View File

Before

Width:  |  Height:  |  Size: 148 B

After

Width:  |  Height:  |  Size: 148 B

View File

Before

Width:  |  Height:  |  Size: 153 B

After

Width:  |  Height:  |  Size: 153 B

View File

Before

Width:  |  Height:  |  Size: 165 B

After

Width:  |  Height:  |  Size: 165 B

View File

@ -0,0 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-lightbulb" viewBox="0 0 16 16">
<path d="M2 6a6 6 0 1 1 10.174 4.31c-.203.196-.359.4-.453.619l-.762 1.769A.5.5 0 0 1 10.5 13a.5.5 0 0 1 0 1 .5.5 0 0 1 0 1l-.224.447a1 1 0 0 1-.894.553H6.618a1 1 0 0 1-.894-.553L5.5 15a.5.5 0 0 1 0-1 .5.5 0 0 1 0-1 .5.5 0 0 1-.46-.302l-.761-1.77a1.964 1.964 0 0 0-.453-.618A5.984 5.984 0 0 1 2 6zm6-5a5 5 0 0 0-3.479 8.592c.263.254.514.564.676.941L5.83 12h4.342l.632-1.467c.162-.377.413-.687.676-.941A5 5 0 0 0 8 1z"/>
</svg>

After

Width:  |  Height:  |  Size: 556 B

View File

Before

Width:  |  Height:  |  Size: 1.4 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

View File

Before

Width:  |  Height:  |  Size: 763 B

After

Width:  |  Height:  |  Size: 763 B

View File

Before

Width:  |  Height:  |  Size: 101 B

After

Width:  |  Height:  |  Size: 101 B

View File

Before

Width:  |  Height:  |  Size: 601 B

After

Width:  |  Height:  |  Size: 601 B

View File

Before

Width:  |  Height:  |  Size: 402 B

After

Width:  |  Height:  |  Size: 402 B

View File

Before

Width:  |  Height:  |  Size: 482 B

After

Width:  |  Height:  |  Size: 482 B

View File

Before

Width:  |  Height:  |  Size: 261 B

After

Width:  |  Height:  |  Size: 261 B

View File

Before

Width:  |  Height:  |  Size: 162 B

After

Width:  |  Height:  |  Size: 162 B

View File

Before

Width:  |  Height:  |  Size: 547 B

After

Width:  |  Height:  |  Size: 547 B

View File

Before

Width:  |  Height:  |  Size: 594 B

After

Width:  |  Height:  |  Size: 594 B

View File

Before

Width:  |  Height:  |  Size: 535 B

After

Width:  |  Height:  |  Size: 535 B

View File

Before

Width:  |  Height:  |  Size: 740 B

After

Width:  |  Height:  |  Size: 740 B

View File

Before

Width:  |  Height:  |  Size: 743 B

After

Width:  |  Height:  |  Size: 743 B

View File

Before

Width:  |  Height:  |  Size: 1.2 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

View File

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

View File

Before

Width:  |  Height:  |  Size: 1.2 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

View File

Before

Width:  |  Height:  |  Size: 848 B

After

Width:  |  Height:  |  Size: 848 B

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

Before

Width:  |  Height:  |  Size: 995 B

After

Width:  |  Height:  |  Size: 995 B

View File

Before

Width:  |  Height:  |  Size: 148 B

After

Width:  |  Height:  |  Size: 148 B

View File

Before

Width:  |  Height:  |  Size: 157 B

After

Width:  |  Height:  |  Size: 157 B

View File

Before

Width:  |  Height:  |  Size: 299 B

After

Width:  |  Height:  |  Size: 299 B

View File

Before

Width:  |  Height:  |  Size: 238 B

After

Width:  |  Height:  |  Size: 238 B

View File

Before

Width:  |  Height:  |  Size: 485 B

After

Width:  |  Height:  |  Size: 485 B

View File

Before

Width:  |  Height:  |  Size: 477 B

After

Width:  |  Height:  |  Size: 477 B

View File

Before

Width:  |  Height:  |  Size: 474 B

After

Width:  |  Height:  |  Size: 474 B

View File

@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-exclamation-triangle" viewBox="0 0 16 16">
<path d="M7.938 2.016A.13.13 0 0 1 8.002 2a.13.13 0 0 1 .063.016.146.146 0 0 1 .054.057l6.857 11.667c.036.06.035.124.002.183a.163.163 0 0 1-.054.06.116.116 0 0 1-.066.017H1.146a.115.115 0 0 1-.066-.017.163.163 0 0 1-.054-.06.176.176 0 0 1 .002-.183L7.884 2.073a.147.147 0 0 1 .054-.057zm1.044-.45a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566z"/>
<path d="M7.002 12a1 1 0 1 1 2 0 1 1 0 0 1-2 0zM7.1 5.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995z"/>
</svg>

After

Width:  |  Height:  |  Size: 685 B

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 125 KiB

After

Width:  |  Height:  |  Size: 125 KiB

View File

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 68 KiB

View File

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 91 KiB

View File

Before

Width:  |  Height:  |  Size: 193 KiB

After

Width:  |  Height:  |  Size: 193 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 6.2 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 9.3 KiB

After

Width:  |  Height:  |  Size: 9.3 KiB

View File

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

Before

Width:  |  Height:  |  Size: 9.7 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

View File

Before

Width:  |  Height:  |  Size: 191 KiB

After

Width:  |  Height:  |  Size: 191 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

View File

Before

Width:  |  Height:  |  Size: 7.0 KiB

After

Width:  |  Height:  |  Size: 7.0 KiB

View File

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 5.3 KiB

View File

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 7.1 KiB

View File

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

Before

Width:  |  Height:  |  Size: 148 KiB

After

Width:  |  Height:  |  Size: 148 KiB

View File

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Some files were not shown because too many files have changed in this diff Show More