2009-12-29 12:12:26 +00:00
|
|
|
# CMakeLists.txt
|
|
|
|
#
|
|
|
|
# Wireshark - Network traffic analyzer
|
|
|
|
# By Gerald Combs <gerald@wireshark.org>
|
|
|
|
# Copyright 1998 Gerald Combs
|
|
|
|
#
|
2018-02-07 11:26:45 +00:00
|
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
2009-12-29 12:12:26 +00:00
|
|
|
#
|
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
# To do:
|
|
|
|
# - Rename *.asciidoc to *.adoc
|
|
|
|
# - Make the build targets top-level on Windows, similar to the NSIS,
|
|
|
|
# WiX, and PortableApps targets?
|
|
|
|
|
|
|
|
find_package( Asciidoctor 1.5 )
|
|
|
|
find_package( XSLTPROC )
|
|
|
|
|
|
|
|
function(set_docbook_target_properties _target)
|
|
|
|
set_target_properties(${_target} PROPERTIES
|
|
|
|
FOLDER "Docbook"
|
|
|
|
EXCLUDE_FROM_DEFAULT_BUILD True
|
|
|
|
)
|
|
|
|
endfunction(set_docbook_target_properties)
|
2017-11-18 21:53:46 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
if(WIN32)
|
|
|
|
find_package( HTMLHelp )
|
2017-03-31 16:13:01 +00:00
|
|
|
if(HTML_HELP_COMPILER)
|
|
|
|
# We do not need the HTML Help headers and library, just the
|
|
|
|
# compiler. To avoid confusion, report the package as found.
|
|
|
|
# https://gitlab.kitware.com/cmake/cmake/issues/15886
|
|
|
|
set(HTMLHelp_FOUND 1)
|
|
|
|
endif()
|
2015-01-09 16:58:15 +00:00
|
|
|
macro( HHP2CHM _hhpsource )
|
|
|
|
get_filename_component( _source_base_name ${_hhpsource} NAME_WE )
|
2015-01-07 00:59:32 +00:00
|
|
|
|
2015-01-09 16:58:15 +00:00
|
|
|
add_custom_command(
|
2015-01-07 00:59:32 +00:00
|
|
|
OUTPUT ${_output_chm}
|
|
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
2015-01-09 16:58:15 +00:00
|
|
|
# The number and order of arguments MUST match hhc.cmake.
|
|
|
|
COMMAND ${CMAKE_COMMAND} -P
|
|
|
|
${CMAKE_SOURCE_DIR}/cmake/modules/hhc.cmake
|
|
|
|
"${HTML_HELP_COMPILER}"
|
|
|
|
${_hhpsource}
|
2015-01-07 00:59:32 +00:00
|
|
|
DEPENDS
|
|
|
|
${_hhpsource}
|
|
|
|
)
|
2015-01-09 16:58:15 +00:00
|
|
|
endmacro()
|
2015-01-07 00:59:32 +00:00
|
|
|
else()
|
2015-01-09 16:58:15 +00:00
|
|
|
macro( HHP2CHM _hhpsource )
|
2015-01-07 00:59:32 +00:00
|
|
|
# Dummy.
|
2015-01-09 16:58:15 +00:00
|
|
|
endmacro()
|
2015-01-07 00:59:32 +00:00
|
|
|
endif()
|
|
|
|
|
2017-08-18 19:32:17 +00:00
|
|
|
set(COMMON_FILES
|
|
|
|
common_src/GPL_appendix.asciidoc
|
|
|
|
)
|
|
|
|
|
2014-07-24 01:28:32 +00:00
|
|
|
set(COMMON_GRAPHICS
|
|
|
|
common_graphics/note.svg
|
|
|
|
common_graphics/tip.svg
|
|
|
|
common_graphics/warning.svg
|
|
|
|
)
|
|
|
|
|
2017-09-25 21:06:37 +00:00
|
|
|
set(WSUG_TOOLS_HELP_COMMANDS
|
|
|
|
capinfos
|
|
|
|
editcap
|
|
|
|
mergecap
|
|
|
|
reordercap
|
|
|
|
text2pcap
|
|
|
|
tshark
|
|
|
|
)
|
|
|
|
|
2018-07-20 23:30:51 +00:00
|
|
|
if (PCAP_FOUND)
|
|
|
|
list(APPEND WSUG_TOOLS_HELP_COMMANDS
|
|
|
|
dumpcap
|
|
|
|
rawshark
|
|
|
|
)
|
|
|
|
endif(PCAP_FOUND)
|
|
|
|
|
2018-07-23 18:26:22 +00:00
|
|
|
# We want the wsug_* targets to depend on our tools help files. However,
|
|
|
|
# each WSUG_TOOLS_HELP_COMMANDS target depends on its corresponding
|
|
|
|
# binary. Due to this and the following issues update_tools_help should
|
|
|
|
# be as independent as possible:
|
|
|
|
# - Aside from the first line (which contains the git commit ID) each
|
|
|
|
# command's `-h` output might change every few months or years.
|
|
|
|
# - It changes files in the source directory, which usually gives you
|
|
|
|
# git changes that you probably don't want or at least don't care about.
|
|
|
|
# - Having our documentation depend on our executables increases the
|
|
|
|
# likelihood of unwanted rebuilds, particularly on the Buildbot.
|
2017-09-25 21:06:37 +00:00
|
|
|
set(WSUG_TOOLS_HELP_FILES)
|
2018-02-11 22:34:04 +00:00
|
|
|
set(GUIDE_INSTALL_DIRS)
|
2017-09-25 21:06:37 +00:00
|
|
|
|
|
|
|
# General help output
|
2018-07-20 23:30:51 +00:00
|
|
|
|
2017-09-25 21:06:37 +00:00
|
|
|
foreach(th_command ${WSUG_TOOLS_HELP_COMMANDS})
|
2018-07-23 15:58:50 +00:00
|
|
|
if(NOT DEFINED BUILD_${th_command})
|
|
|
|
# Catch typos, these commands must exist in CMakeOptions.txt
|
|
|
|
message(WARNING "BUILD_${th_command} is an unknown option")
|
|
|
|
endif()
|
|
|
|
if(NOT BUILD_${th_command})
|
|
|
|
message(STATUS "WSUG: will not update ${th_command} output")
|
|
|
|
continue()
|
|
|
|
endif()
|
|
|
|
|
2017-09-25 21:06:37 +00:00
|
|
|
set(th_file ${CMAKE_CURRENT_SOURCE_DIR}/wsug_src/${th_command}-h.txt)
|
|
|
|
list(APPEND WSUG_TOOLS_HELP_FILES ${th_file})
|
|
|
|
add_custom_command(
|
2018-07-20 20:55:40 +00:00
|
|
|
OUTPUT ${th_file}
|
2018-07-23 18:26:22 +00:00
|
|
|
COMMAND ${th_command} -h > ${th_file}
|
|
|
|
DEPENDS ${th_command}
|
2017-09-25 21:06:37 +00:00
|
|
|
)
|
|
|
|
endforeach()
|
|
|
|
|
|
|
|
# Extra command output
|
|
|
|
# Note that these won't work on Windows unless we make -F and -T write
|
|
|
|
# to stdout and return 0 or wrap the commands similar to hhc.exe.
|
2018-07-23 15:58:50 +00:00
|
|
|
if(BUILD_editcap)
|
|
|
|
set(th_file ${CMAKE_CURRENT_SOURCE_DIR}/wsug_src/editcap-F.txt)
|
|
|
|
list(APPEND WSUG_TOOLS_HELP_FILES ${th_file})
|
|
|
|
add_custom_command(
|
|
|
|
OUTPUT ${th_file}
|
2018-07-23 18:26:22 +00:00
|
|
|
COMMAND editcap -F > ${th_file}
|
|
|
|
DEPENDS editcap
|
2018-07-23 15:58:50 +00:00
|
|
|
)
|
|
|
|
set(th_file ${CMAKE_CURRENT_SOURCE_DIR}/wsug_src/editcap-T.txt)
|
|
|
|
list(APPEND WSUG_TOOLS_HELP_FILES ${th_file})
|
|
|
|
add_custom_command(
|
|
|
|
OUTPUT ${th_file}
|
2018-07-23 18:26:22 +00:00
|
|
|
COMMAND editcap -T > ${th_file}
|
|
|
|
DEPENDS editcap
|
2018-07-23 15:58:50 +00:00
|
|
|
)
|
|
|
|
else()
|
|
|
|
message(STATUS "WSUG: will not update editcap output")
|
|
|
|
endif()
|
2017-09-25 21:06:37 +00:00
|
|
|
|
|
|
|
add_custom_target(update_tools_help
|
2018-07-20 20:55:40 +00:00
|
|
|
DEPENDS ${WSUG_TOOLS_HELP_FILES}
|
2017-09-25 21:06:37 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(update_tools_help)
|
2017-09-25 21:06:37 +00:00
|
|
|
|
2009-12-29 12:12:26 +00:00
|
|
|
set(WSUG_FILES
|
2014-11-09 06:05:52 +00:00
|
|
|
wsug_src/WSUG_app_files.asciidoc
|
2014-11-09 18:07:46 +00:00
|
|
|
wsug_src/WSUG_app_howitworks.asciidoc
|
|
|
|
wsug_src/WSUG_app_protocols.asciidoc
|
|
|
|
wsug_src/WSUG_app_messages.asciidoc
|
2014-11-09 19:39:15 +00:00
|
|
|
wsug_src/WSUG_app_tools.asciidoc
|
2014-09-01 01:40:56 +00:00
|
|
|
wsug_src/WSUG_chapter_advanced.asciidoc
|
2014-07-30 01:31:43 +00:00
|
|
|
wsug_src/WSUG_chapter_build_install.asciidoc
|
2014-08-25 22:41:07 +00:00
|
|
|
wsug_src/WSUG_chapter_capture.asciidoc
|
2014-11-02 03:52:34 +00:00
|
|
|
wsug_src/WSUG_chapter_customize.asciidoc
|
2014-07-17 01:38:42 +00:00
|
|
|
wsug_src/WSUG_chapter_introduction.asciidoc
|
2014-08-31 01:02:52 +00:00
|
|
|
wsug_src/WSUG_chapter_io.asciidoc
|
2016-07-04 21:21:28 +00:00
|
|
|
wsug_src/WSUG_chapter_mate.asciidoc
|
2014-08-02 22:42:20 +00:00
|
|
|
wsug_src/WSUG_chapter_statistics.asciidoc
|
2014-09-01 04:52:32 +00:00
|
|
|
wsug_src/WSUG_chapter_telephony.asciidoc
|
2014-11-09 18:20:26 +00:00
|
|
|
wsug_src/WSUG_chapter_troubleshoot.asciidoc
|
2014-08-17 16:23:31 +00:00
|
|
|
wsug_src/WSUG_chapter_use.asciidoc
|
2014-08-31 20:47:39 +00:00
|
|
|
wsug_src/WSUG_chapter_work.asciidoc
|
2014-07-17 01:38:42 +00:00
|
|
|
wsug_src/WSUG_preface.asciidoc
|
2017-08-18 19:32:17 +00:00
|
|
|
${COMMON_FILES}
|
2014-07-17 01:38:42 +00:00
|
|
|
)
|
|
|
|
|
2009-12-29 12:12:26 +00:00
|
|
|
set(WSUG_GRAPHICS
|
2016-01-09 22:24:45 +00:00
|
|
|
wsug_graphics/related-ack.png
|
|
|
|
wsug_graphics/related-current.png
|
|
|
|
wsug_graphics/related-dup-ack.png
|
|
|
|
wsug_graphics/related-first.png
|
|
|
|
wsug_graphics/related-last.png
|
|
|
|
wsug_graphics/related-other.png
|
|
|
|
wsug_graphics/related-request.png
|
|
|
|
wsug_graphics/related-response.png
|
|
|
|
wsug_graphics/related-segment.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-analyze-menu.png
|
|
|
|
wsug_graphics/ws-bytes-pane-tabs.png
|
|
|
|
wsug_graphics/ws-bytes-pane.png
|
|
|
|
wsug_graphics/ws-capture-info.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-capture-interface-details.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-capture-interfaces.png
|
|
|
|
wsug_graphics/ws-capture-interfaces-win32.png
|
|
|
|
wsug_graphics/ws-capture-menu.png
|
|
|
|
wsug_graphics/ws-capture-options.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-capture-options-compile-selected-bpfs.png
|
|
|
|
wsug_graphics/ws-capture-options-manage-interfaces-local.png
|
|
|
|
wsug_graphics/ws-capture-options-manage-interfaces-pipes.png
|
|
|
|
wsug_graphics/ws-capture-options-manage-interfaces-remote-plus.png
|
|
|
|
wsug_graphics/ws-capture-options-manage-interfaces-remote.png
|
|
|
|
wsug_graphics/ws-capture-options-manage-interfaces.png
|
|
|
|
wsug_graphics/ws-capture-options-output.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-capture-options-remote-capture.png
|
|
|
|
wsug_graphics/ws-capture-options-remote-interface.png
|
|
|
|
wsug_graphics/ws-capture-options-remote-settings.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-capture-options-settings.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-capture-preferences.png
|
|
|
|
wsug_graphics/ws-choose-color-rule.png
|
|
|
|
wsug_graphics/ws-coloring-fields.png
|
|
|
|
wsug_graphics/ws-coloring-rules-dialog.png
|
2011-01-09 22:17:14 +00:00
|
|
|
wsug_graphics/ws-column-header-popup-menu.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-decode-as-show.png
|
|
|
|
wsug_graphics/ws-decode-as.png
|
|
|
|
wsug_graphics/ws-details-pane-popup-menu.png
|
|
|
|
wsug_graphics/ws-details-pane.png
|
|
|
|
wsug_graphics/ws-display-filter-tcp.png
|
|
|
|
wsug_graphics/ws-edit-menu.png
|
|
|
|
wsug_graphics/ws-enabled-protocols.png
|
|
|
|
wsug_graphics/ws-expert-colored-tree.png
|
|
|
|
wsug_graphics/ws-expert-column.png
|
|
|
|
wsug_graphics/ws-expert-infos.png
|
|
|
|
wsug_graphics/ws-export-objects.png
|
|
|
|
wsug_graphics/ws-export-pdml.png
|
|
|
|
wsug_graphics/ws-export-plain.png
|
|
|
|
wsug_graphics/ws-export-ps.png
|
|
|
|
wsug_graphics/ws-export-psml.png
|
|
|
|
wsug_graphics/ws-export-selected.png
|
2010-11-22 12:03:28 +00:00
|
|
|
wsug_graphics/ws-file-import.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-file-menu.png
|
|
|
|
wsug_graphics/ws-file-set-dialog.png
|
|
|
|
wsug_graphics/ws-filter-add-expression.png
|
|
|
|
wsug_graphics/ws-filter-toolbar.png
|
|
|
|
wsug_graphics/ws-filters.png
|
|
|
|
wsug_graphics/ws-find-packet.png
|
|
|
|
wsug_graphics/ws-follow-stream.png
|
|
|
|
wsug_graphics/ws-go-menu.png
|
|
|
|
wsug_graphics/ws-goto-packet.png
|
|
|
|
wsug_graphics/ws-gui-colors-preferences.png
|
|
|
|
wsug_graphics/ws-gui-columns-preferences.png
|
|
|
|
wsug_graphics/ws-gui-config-profiles.png
|
|
|
|
wsug_graphics/ws-gui-font-preferences.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-gui-interface-options.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-gui-layout-preferences.png
|
|
|
|
wsug_graphics/ws-gui-preferences.png
|
|
|
|
wsug_graphics/ws-help-menu.png
|
2011-01-27 07:26:21 +00:00
|
|
|
wsug_graphics/ws-internals-menu.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-list-pane.png
|
|
|
|
wsug_graphics/ws-logo.png
|
|
|
|
wsug_graphics/ws-main-toolbar.png
|
|
|
|
wsug_graphics/ws-main.png
|
2016-07-04 21:21:28 +00:00
|
|
|
wsug_graphics/ws-mate-analysis.png
|
|
|
|
wsug_graphics/ws-mate-dns_pane.png
|
|
|
|
wsug_graphics/ws-mate-dns_pdu.png
|
|
|
|
wsug_graphics/ws-mate-ftp_over_gre.png
|
|
|
|
wsug_graphics/ws-mate-gop_analysis.png
|
|
|
|
wsug_graphics/ws-mate-isup_over_mtp3_over_ip.png
|
|
|
|
wsug_graphics/ws-mate-mmse_over_http.png
|
|
|
|
wsug_graphics/ws-mate-pdu_analysis.png
|
|
|
|
wsug_graphics/ws-mate-tcp-output.png
|
|
|
|
wsug_graphics/ws-mate-transform.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-menu.png
|
|
|
|
wsug_graphics/ws-merge-gtk24.png
|
|
|
|
wsug_graphics/ws-merge-win32.png
|
|
|
|
wsug_graphics/ws-nameresolution-preferences.png
|
|
|
|
wsug_graphics/ws-open-gtk24.png
|
|
|
|
wsug_graphics/ws-open-win32.png
|
|
|
|
wsug_graphics/ws-packet-format.png
|
|
|
|
wsug_graphics/ws-packet-pane-popup-menu.png
|
|
|
|
wsug_graphics/ws-packet-range.png
|
|
|
|
wsug_graphics/ws-packet-selected.png
|
|
|
|
wsug_graphics/ws-packet-sep-win.png
|
|
|
|
wsug_graphics/ws-print.png
|
|
|
|
wsug_graphics/ws-printing-preferences.png
|
|
|
|
wsug_graphics/ws-save-as-gtk24.png
|
|
|
|
wsug_graphics/ws-save-as-win32.png
|
|
|
|
wsug_graphics/ws-statistics-menu.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-stats-compare.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-stats-conversations.png
|
|
|
|
wsug_graphics/ws-stats-endpoints.png
|
|
|
|
wsug_graphics/ws-stats-hierarchy.png
|
|
|
|
wsug_graphics/ws-stats-iographs.png
|
|
|
|
wsug_graphics/ws-stats-srt-dcerpc-filter.png
|
|
|
|
wsug_graphics/ws-stats-srt-dcerpc.png
|
|
|
|
wsug_graphics/ws-stats-summary.png
|
|
|
|
wsug_graphics/ws-stats-lte-mac-traffic.png
|
2010-01-22 12:42:53 +00:00
|
|
|
wsug_graphics/ws-stats-lte-rlc-traffic.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-stats-wlan-traffic.png
|
|
|
|
wsug_graphics/ws-statusbar-empty.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-statusbar-filter.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-statusbar-loaded.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-statusbar-profile.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-statusbar-selected.png
|
2018-05-12 11:31:35 +00:00
|
|
|
wsug_graphics/ws-tcp-analysis.png
|
|
|
|
wsug_graphics/ws-tel-rtpstream-analysis.png
|
2011-01-09 22:17:14 +00:00
|
|
|
wsug_graphics/ws-telephony-menu.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-time-reference.png
|
2011-01-09 22:17:14 +00:00
|
|
|
wsug_graphics/ws-tools-menu.png
|
2009-12-29 12:12:26 +00:00
|
|
|
wsug_graphics/ws-view-menu.png
|
|
|
|
wsug_graphics/toolbar/autoscroll_24.png
|
|
|
|
wsug_graphics/toolbar/capture_filter_24.png
|
|
|
|
wsug_graphics/toolbar/capture_interfaces_24.png
|
|
|
|
wsug_graphics/toolbar/capture_options_24.png
|
|
|
|
wsug_graphics/toolbar/capture_restart_24.png
|
|
|
|
wsug_graphics/toolbar/capture_start_24.png
|
|
|
|
wsug_graphics/toolbar/capture_stop_24.png
|
|
|
|
wsug_graphics/toolbar/colorize_24.png
|
|
|
|
wsug_graphics/toolbar/display_filter_24.png
|
|
|
|
wsug_graphics/toolbar/resize_columns_24.png
|
|
|
|
wsug_graphics/toolbar/stock_add_24.png
|
|
|
|
wsug_graphics/toolbar/stock_apply_20.png
|
|
|
|
wsug_graphics/toolbar/stock_bottom_24.png
|
|
|
|
wsug_graphics/toolbar/stock_clear_24.png
|
|
|
|
wsug_graphics/toolbar/stock_close_24.png
|
|
|
|
wsug_graphics/toolbar/stock_colorselector_24.png
|
|
|
|
wsug_graphics/toolbar/stock_help_24.png
|
|
|
|
wsug_graphics/toolbar/stock_jump_to_24.png
|
|
|
|
wsug_graphics/toolbar/stock_left_arrow_24.png
|
|
|
|
wsug_graphics/toolbar/stock_open_24.png
|
|
|
|
wsug_graphics/toolbar/stock_preferences_24.png
|
|
|
|
wsug_graphics/toolbar/stock_print_24.png
|
|
|
|
wsug_graphics/toolbar/stock_properties_24.png
|
|
|
|
wsug_graphics/toolbar/stock_refresh_24.png
|
|
|
|
wsug_graphics/toolbar/stock_right_arrow_24.png
|
|
|
|
wsug_graphics/toolbar/stock_save_24.png
|
|
|
|
wsug_graphics/toolbar/stock_save_as_24.png
|
|
|
|
wsug_graphics/toolbar/stock_search_24.png
|
|
|
|
wsug_graphics/toolbar/stock_stop_24.png
|
|
|
|
wsug_graphics/toolbar/stock_top_24.png
|
|
|
|
wsug_graphics/toolbar/stock_zoom_1_24.png
|
|
|
|
wsug_graphics/toolbar/stock_zoom_in_24.png
|
|
|
|
wsug_graphics/toolbar/stock_zoom_out_24.png
|
2014-07-24 01:28:32 +00:00
|
|
|
${COMMON_GRAPHICS}
|
2009-12-29 12:12:26 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
set(WSDG_FILES
|
2014-02-02 19:00:30 +00:00
|
|
|
wsdg_src/WSDG_chapter_build_intro.asciidoc
|
|
|
|
wsdg_src/WSDG_chapter_capture.asciidoc
|
2014-02-03 18:28:37 +00:00
|
|
|
wsdg_src/WSDG_chapter_dissection.asciidoc
|
2014-01-27 04:20:44 +00:00
|
|
|
wsdg_src/WSDG_chapter_env_intro.asciidoc
|
2014-02-01 19:26:38 +00:00
|
|
|
wsdg_src/WSDG_chapter_libraries.asciidoc
|
2014-02-02 19:00:30 +00:00
|
|
|
wsdg_src/WSDG_chapter_quick_setup.asciidoc
|
2014-01-24 01:10:10 +00:00
|
|
|
wsdg_src/WSDG_chapter_sources.asciidoc
|
2014-02-01 01:47:21 +00:00
|
|
|
wsdg_src/WSDG_chapter_tools.asciidoc
|
2014-02-06 17:16:33 +00:00
|
|
|
wsdg_src/WSDG_chapter_userinterface.asciidoc
|
2014-02-02 19:00:30 +00:00
|
|
|
wsdg_src/WSDG_chapter_works.asciidoc
|
2014-01-27 03:08:01 +00:00
|
|
|
wsdg_src/WSDG_preface.asciidoc
|
2015-08-07 22:08:22 +00:00
|
|
|
wsluarm.asciidoc
|
2017-08-18 19:32:17 +00:00
|
|
|
${COMMON_FILES}
|
2014-01-24 01:10:10 +00:00
|
|
|
)
|
|
|
|
|
2009-12-29 12:12:26 +00:00
|
|
|
set(WSDG_GRAPHICS
|
|
|
|
wsdg_graphics/ws-capture-sync.dia
|
|
|
|
wsdg_graphics/ws-capture-sync.png
|
|
|
|
wsdg_graphics/ws-capture_internals.dia
|
|
|
|
wsdg_graphics/ws-capture_internals.png
|
|
|
|
wsdg_graphics/ws-function-blocks.dia
|
|
|
|
wsdg_graphics/ws-function-blocks.png
|
|
|
|
wsdg_graphics/ws-logo.png
|
2014-07-24 01:28:32 +00:00
|
|
|
${COMMON_GRAPHICS}
|
2009-12-29 12:12:26 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
set(WSUG_SOURCE
|
|
|
|
${WSUG_FILES}
|
|
|
|
${WSUG_GRAPHICS}
|
|
|
|
)
|
|
|
|
|
2015-11-21 12:13:39 +00:00
|
|
|
if(NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
|
|
|
|
add_custom_command(
|
|
|
|
OUTPUT ws.css
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E copy_if_different
|
|
|
|
${CMAKE_CURRENT_SOURCE_DIR}/ws.css
|
|
|
|
${CMAKE_CURRENT_BINARY_DIR}/ws.css
|
|
|
|
DEPENDS
|
|
|
|
${CMAKE_CURRENT_SOURCE_DIR}/ws.css
|
|
|
|
)
|
|
|
|
endif()
|
2014-12-11 00:50:56 +00:00
|
|
|
|
2018-07-23 20:47:35 +00:00
|
|
|
set( WSUG_BUILT_DEPS ws.css update_tools_help)
|
2014-01-25 00:17:19 +00:00
|
|
|
|
2009-12-29 12:12:26 +00:00
|
|
|
set(WSDG_SOURCE
|
|
|
|
${WSDG_FILES}
|
|
|
|
${WSDG_GRAPHICS}
|
|
|
|
)
|
|
|
|
|
2015-07-07 15:30:44 +00:00
|
|
|
# Note: file order here MATTERS!
|
|
|
|
# new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE
|
|
|
|
# files for the same module
|
2009-12-29 12:12:26 +00:00
|
|
|
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
|
2014-02-03 03:49:30 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_int64.c
|
2009-12-29 12:12:26 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c
|
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c
|
2015-07-07 15:30:44 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_address.c
|
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_column.c
|
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_nstime.c
|
2009-12-29 12:12:26 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c
|
2015-07-07 15:30:44 +00:00
|
|
|
${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
|
2009-12-29 12:12:26 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c
|
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c
|
2015-07-07 15:30:44 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_byte_array.c
|
2014-03-18 17:21:51 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file.c
|
2015-07-07 15:30:44 +00:00
|
|
|
${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
|
2014-03-26 06:24:51 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dir.c
|
2009-12-29 12:12:26 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_util.c
|
2014-02-03 03:49:30 +00:00
|
|
|
${CMAKE_SOURCE_DIR}/epan/wslua/wslua_struct.c
|
2009-12-29 12:12:26 +00:00
|
|
|
)
|
|
|
|
|
2015-08-08 01:17:04 +00:00
|
|
|
# Empty file to trigger wsluarm generation.
|
|
|
|
ADD_CUSTOM_COMMAND(
|
|
|
|
OUTPUT
|
|
|
|
wsluarm
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory wsluarm_src
|
|
|
|
COMMAND ${PERL_EXECUTABLE}
|
|
|
|
${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.pl
|
|
|
|
${WSLUA_MODULES}
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E touch
|
|
|
|
wsluarm
|
|
|
|
DEPENDS
|
|
|
|
${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.pl
|
|
|
|
${WSLUA_MODULES}
|
|
|
|
)
|
|
|
|
|
|
|
|
set( WSDG_BUILT_DEPS ws.css wsluarm )
|
|
|
|
|
2016-12-15 19:54:01 +00:00
|
|
|
set( ASCIIDOC_CONF_FILES
|
|
|
|
attributes.asciidoc
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
# XXX Add macros
|
2016-12-15 19:54:01 +00:00
|
|
|
)
|
|
|
|
|
2018-07-03 09:42:20 +00:00
|
|
|
if(ASCIIDOCTOR_FOUND)
|
2015-08-08 22:44:02 +00:00
|
|
|
# Generate the DocBook sources of user and developer guides
|
2015-08-08 01:17:04 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
ASCIIDOCTOR2DOCBOOK(user-guide.asciidoc ${ASCIIDOC_CONF_FILES} ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
|
2016-02-26 00:03:45 +00:00
|
|
|
add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(user_guide_docbook)
|
2015-08-08 01:17:04 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
ASCIIDOCTOR2DOCBOOK(developer-guide.asciidoc ${ASCIIDOC_CONF_FILES} ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
|
2016-02-26 00:03:45 +00:00
|
|
|
add_custom_target(developer_guide_docbook DEPENDS generate_developer-guide.xml)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(developer_guide_docbook)
|
2015-08-08 22:44:02 +00:00
|
|
|
|
|
|
|
# Top-level guide targets.
|
|
|
|
|
|
|
|
add_custom_target(user_guides DEPENDS user_guide_docbook)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(user_guides)
|
2015-08-08 22:44:02 +00:00
|
|
|
|
|
|
|
add_custom_target(developer_guides DEPENDS developer_guide_docbook)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(developer_guides)
|
2015-08-08 22:44:02 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
add_custom_target(all_guides DEPENDS user_guides developer_guides )
|
|
|
|
set_docbook_target_properties(all_guides)
|
2015-08-08 22:44:02 +00:00
|
|
|
endif()
|
2015-08-08 01:17:04 +00:00
|
|
|
|
|
|
|
# User's Guide chain.
|
2018-07-03 09:42:20 +00:00
|
|
|
if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
|
2015-08-08 01:17:04 +00:00
|
|
|
XML2HTML(
|
|
|
|
user_guide
|
|
|
|
wsug
|
|
|
|
single-page
|
|
|
|
user-guide.xml
|
|
|
|
WSUG_GRAPHICS
|
|
|
|
)
|
|
|
|
|
|
|
|
XML2HTML(
|
|
|
|
user_guide
|
|
|
|
wsug
|
|
|
|
chunked
|
|
|
|
user-guide.xml
|
|
|
|
WSUG_GRAPHICS
|
|
|
|
)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_custom_target(
|
|
|
|
user_guide_html
|
|
|
|
DEPENDS
|
2015-08-08 01:17:04 +00:00
|
|
|
wsug_html/index.html
|
|
|
|
wsug_html_chunked/index.html
|
2015-08-07 22:08:22 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(user_guide_html)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_dependencies(user_guides user_guide_html)
|
2018-02-11 22:34:04 +00:00
|
|
|
list(APPEND GUIDE_INSTALL_DIRS ${CMAKE_CURRENT_BINARY_DIR}/wsug_html_chunked)
|
2014-12-11 00:50:56 +00:00
|
|
|
endif()
|
|
|
|
|
2018-07-03 09:42:20 +00:00
|
|
|
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
ASCIIDOCTOR2PDF(user-guide.asciidoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS})
|
2015-08-07 22:08:22 +00:00
|
|
|
|
2015-08-08 01:17:04 +00:00
|
|
|
add_custom_target(
|
2018-01-23 19:02:16 +00:00
|
|
|
user_guide_pdf
|
2015-08-08 01:17:04 +00:00
|
|
|
DEPENDS
|
2018-01-23 19:02:16 +00:00
|
|
|
user-guide.pdf
|
2015-08-08 01:17:04 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(user_guide_pdf)
|
2018-01-23 19:02:16 +00:00
|
|
|
add_dependencies(user_guides user_guide_pdf)
|
2014-12-11 00:50:56 +00:00
|
|
|
endif()
|
|
|
|
|
2018-07-03 09:42:20 +00:00
|
|
|
if(WIN32 AND ASCIIDOCTOR_FOUND)
|
2015-08-08 01:17:04 +00:00
|
|
|
XML2HHP(user_guide wsug user-guide.xml)
|
2015-01-07 00:59:32 +00:00
|
|
|
HHP2CHM(user-guide.hhp)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_custom_target(
|
|
|
|
user_guide_chm
|
|
|
|
DEPENDS
|
2015-08-08 01:17:04 +00:00
|
|
|
user-guide.chm
|
2015-08-07 22:08:22 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(user_guide_chm)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_dependencies(user_guides user_guide_chm)
|
2015-01-07 00:59:32 +00:00
|
|
|
endif()
|
2009-12-29 12:12:26 +00:00
|
|
|
|
2015-08-08 01:17:04 +00:00
|
|
|
# Developer's Guide chain.
|
2018-07-03 09:42:20 +00:00
|
|
|
if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
|
2015-08-08 01:17:04 +00:00
|
|
|
XML2HTML(
|
|
|
|
developer_guide
|
|
|
|
wsdg
|
|
|
|
single-page
|
|
|
|
developer-guide.xml
|
|
|
|
WSDG_GRAPHICS
|
|
|
|
)
|
|
|
|
|
|
|
|
XML2HTML(
|
|
|
|
developer_guide
|
|
|
|
wsdg
|
|
|
|
chunked
|
|
|
|
developer-guide.xml
|
|
|
|
WSDG_GRAPHICS
|
|
|
|
)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_custom_target(
|
|
|
|
developer_guide_html
|
|
|
|
DEPENDS
|
2015-08-08 01:17:04 +00:00
|
|
|
wsdg_html/index.html
|
|
|
|
wsdg_html_chunked/index.html
|
2015-08-07 22:08:22 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(developer_guide_html)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_dependencies(developer_guides developer_guide_html)
|
2018-02-11 22:34:04 +00:00
|
|
|
list(APPEND GUIDE_INSTALL_DIRS ${CMAKE_CURRENT_BINARY_DIR}/wsdg_html_chunked)
|
2014-12-11 00:50:56 +00:00
|
|
|
endif()
|
|
|
|
|
2018-07-03 09:42:20 +00:00
|
|
|
if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
ASCIIDOCTOR2PDF(developer-guide.asciidoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS})
|
2015-08-07 22:08:22 +00:00
|
|
|
|
2015-08-08 01:17:04 +00:00
|
|
|
add_custom_target(
|
2018-01-23 19:02:16 +00:00
|
|
|
developer_guide_pdf
|
2015-08-08 01:17:04 +00:00
|
|
|
DEPENDS
|
2018-01-23 19:02:16 +00:00
|
|
|
developer-guide.pdf
|
2015-08-08 01:17:04 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(developer_guide_pdf)
|
2018-01-23 19:02:16 +00:00
|
|
|
add_dependencies(developer_guides developer_guide_pdf)
|
2014-12-11 00:50:56 +00:00
|
|
|
endif()
|
|
|
|
|
2018-07-03 09:42:20 +00:00
|
|
|
if(WIN32 AND ASCIIDOCTOR_FOUND)
|
2015-08-08 01:17:04 +00:00
|
|
|
XML2HHP(developer_guide wsdg developer-guide.xml)
|
2015-01-07 00:59:32 +00:00
|
|
|
HHP2CHM(developer-guide.hhp)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_custom_target(
|
|
|
|
developer_guide_chm
|
|
|
|
DEPENDS
|
2015-08-08 01:17:04 +00:00
|
|
|
developer-guide.chm
|
2015-08-07 22:08:22 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(developer_guide_chm)
|
2015-08-07 22:08:22 +00:00
|
|
|
add_dependencies(developer_guides developer_guide_chm)
|
2015-01-07 00:59:32 +00:00
|
|
|
endif()
|
2009-12-29 12:12:26 +00:00
|
|
|
|
2018-02-11 22:34:04 +00:00
|
|
|
if (GUIDE_INSTALL_DIRS)
|
|
|
|
# The installation location and DOC_DIR in ui/help_url.c must
|
|
|
|
# match.
|
|
|
|
add_custom_target(install_guides
|
|
|
|
COMMAND ${CMAKE_COMMAND} -P
|
|
|
|
${CMAKE_SOURCE_DIR}/cmake/modules/FileInstall.cmake
|
|
|
|
${GUIDE_INSTALL_DIRS}
|
|
|
|
${CMAKE_INSTALL_FULL_DOCDIR}
|
|
|
|
DEPENDS
|
|
|
|
user_guide_html developer_guide_html
|
|
|
|
)
|
|
|
|
set_docbook_target_properties(install_guides)
|
|
|
|
endif()
|
|
|
|
|
2018-01-23 19:02:16 +00:00
|
|
|
# release_notes: release-notes.html release-notes.txt
|
2009-12-29 12:12:26 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
add_custom_target( release_notes_html DEPENDS release-notes.html )
|
|
|
|
set_docbook_target_properties(release_notes_html)
|
2014-12-11 00:50:56 +00:00
|
|
|
add_custom_target( release_notes_txt DEPENDS release-notes.txt )
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(release_notes_txt)
|
2013-11-01 09:55:26 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
# Force serial execution so that separate asciidoctor instances don't
|
|
|
|
# trip on each other
|
|
|
|
# add_dependencies ( release_notes_txt release_notes_html )
|
2014-12-11 00:50:56 +00:00
|
|
|
|
|
|
|
add_custom_target( release_notes )
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(release_notes)
|
2014-12-11 00:50:56 +00:00
|
|
|
add_dependencies ( release_notes release_notes_txt release_notes_html )
|
|
|
|
|
|
|
|
add_custom_target(
|
|
|
|
news
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E copy_if_different
|
2013-11-01 09:55:26 +00:00
|
|
|
${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
|
|
|
|
${CMAKE_SOURCE_DIR}/NEWS
|
|
|
|
DEPENDS
|
2015-11-21 12:13:39 +00:00
|
|
|
${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
|
2013-11-01 09:55:26 +00:00
|
|
|
)
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
set_docbook_target_properties(news)
|
2013-11-01 09:55:26 +00:00
|
|
|
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
if( ASCIIDOCTOR_FOUND )
|
2018-02-25 17:17:14 +00:00
|
|
|
ASCIIDOCTOR2HTML( release-notes.asciidoc ws.css )
|
Switch from AsciiDoc to Asciidoctor.
Switch the markup text processor for files in the docbook directory from
AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such
as direct PDF output) and is actively developed. It's written in Ruby
but that dependency can be sidestepped with AsciidoctorJ, a
self-contained bundle that only depends on the JRE.
The current toolchain targets require Python, AsciiDoc, DocBook XML,
DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler:
HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL
PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP
HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC
This change removes the AsciiDoc and FOP requirements and adds either
AsciidoctorJ or Asciidoctor + Ruby:
HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL
PDF: Asciidoctor
HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC
Ideally we could generate all of these using AsciidoctorJ, Java, and
lynx. Unfortunately we're not there yet.
The release notes depend on several macros (ws-buglink, ws-salink,
cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents.
Remove the BUILD_xxx_GUIDES CMake options and add various output targets
automatically. This means that you have to build the various documentation
targets explicitly.
Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a
Reviewed-on: https://code.wireshark.org/review/25668
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
|
|
|
ASCIIDOCTOR2TXT( release-notes.asciidoc )
|
2017-11-18 21:53:46 +00:00
|
|
|
endif()
|
2013-11-01 09:55:26 +00:00
|
|
|
|
2016-10-16 22:35:50 +00:00
|
|
|
#
|
|
|
|
# Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
|
|
#
|
|
|
|
# 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:
|
|
|
|
#
|