osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Docs: Move attributes.adoc to the doc directory

This commit is contained in:
Gerald Combs 2023-11-13 16:01:25 -08:00 committed by AndersBroman
parent a0839b6e5e
commit 6ce97e418b
41 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CMakeLists.txt
View File

@ -3560,7 +3560,7 @@ if(ENABLE_APPLICATION_BUNDLE AND BUILD_wireshark)
COMMAND ${ASCIIDOCTOR_EXECUTABLE}
--backend html
--out-file ${_wireshark_read_me_first}
--attribute include-dir=${CMAKE_SOURCE_DIR}/docbook
--attribute include-dir=${CMAKE_SOURCE_DIR}/doc
--attribute min-macos-version=${MIN_MACOS_VERSION}
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Wireshark_read_me_first.adoc
DEPENDS
@ -3574,7 +3574,7 @@ if(ENABLE_APPLICATION_BUNDLE AND BUILD_wireshark)
COMMAND ${ASCIIDOCTOR_EXECUTABLE}
--backend html
--out-file ${_wireshark_donate}
--attribute include-dir=${CMAKE_SOURCE_DIR}/docbook
--attribute include-dir=${CMAKE_SOURCE_DIR}/doc
--attribute min-macos-version=${MIN_MACOS_VERSION}
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Donate_to_the_Wireshark_Foundation.adoc
DEPENDS
@ -3588,7 +3588,7 @@ if(ENABLE_APPLICATION_BUNDLE AND BUILD_wireshark)
COMMAND ${ASCIIDOCTOR_EXECUTABLE}
--backend html
--out-file ${_wireshark_dsym_installation}
--attribute include-dir=${CMAKE_SOURCE_DIR}/docbook
--attribute include-dir=${CMAKE_SOURCE_DIR}/doc
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Wireshark_dsym_installation.adoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Wireshark_dsym_installation.adoc
@ -3628,7 +3628,7 @@ if(ENABLE_APPLICATION_BUNDLE AND BUILD_logray)
COMMAND ${ASCIIDOCTOR_EXECUTABLE}
--backend html
--out-file ${_logray_read_me_first}
--attribute include-dir=${CMAKE_SOURCE_DIR}/docbook
--attribute include-dir=${CMAKE_SOURCE_DIR}/doc
--attribute min-macos-version=${MIN_MACOS_VERSION}
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Logray_read_me_first.adoc
DEPENDS
@ -3642,7 +3642,7 @@ if(ENABLE_APPLICATION_BUNDLE AND BUILD_logray)
COMMAND ${ASCIIDOCTOR_EXECUTABLE}
--backend html
--out-file ${_logray_dsym_installation}
--attribute include-dir=${CMAKE_SOURCE_DIR}/docbook
--attribute include-dir=${CMAKE_SOURCE_DIR}/doc
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Logray_dsym_installation.adoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/packaging/macosx/Logray_dsym_installation.adoc

14
cmake/modules/FindAsciidoctor.cmake
View File

@ -78,7 +78,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
--out-file ${_output_xml}
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
DEPENDS
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
${ARGN}
)
@ -110,7 +110,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
--out-file ${_output_html}
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
DEPENDS
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
${ARGN}
)
@ -132,7 +132,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
> ${_output_txt}
DEPENDS
${MAN_INCLUDES}
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
${_output_html}
${ARGN}
@ -160,7 +160,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
${_input_adoc}
DEPENDS
${MAN_INCLUDES}
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${_input_adoc}
)
unset(_src_file)
@ -187,7 +187,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
${_input_adoc}
DEPENDS
${MAN_INCLUDES}
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${_input_adoc}
)
unset(_src_file)
@ -232,7 +232,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
--out-file "${_output_pdf}"
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
DEPENDS
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
${ARGN}
VERBATIM
@ -283,7 +283,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
--out-file "${_output_epub}"
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
DEPENDS
${CMAKE_SOURCE_DIR}/docbook/attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
${ARGN}
VERBATIM

2
doc/androiddump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= androiddump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/asn2deb.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= asn2deb(1)
:doctype: manpage
:stylesheet: ws.css

0
docbook/attributes.adoc → doc/attributes.adoc
View File

2
doc/capinfos.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= capinfos(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/captype.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= captype(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/ciscodump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= ciscodump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/dpauxmon.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= dpauxmon(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/dumpcap.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= dumpcap(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/editcap.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= editcap(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/etwdump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= etwdump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/extcap.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= extcap(4)
:doctype: manpage
:stylesheet: ws.css

2
doc/falcodump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= falcodump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/faq.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
:stylesheet: ws.css
:linkcss:
:copycss: {stylesheet}

2
doc/idl2deb.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= idl2deb(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/idl2wrs.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= idl2wrs(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/mergecap.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= mergecap(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/mmdbresolve.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= mmdbresolve(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/randpkt.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= randpkt(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/randpktdump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= randpktdump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/rawshark.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= rawshark(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/release-notes.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
:stylesheet: ws.css
:linkcss:
:copycss: {stylesheet}

2
doc/reordercap.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= reordercap(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/sdjournal.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= sdjournal(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/sshdump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= sshdump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/text2pcap.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= text2pcap(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/tshark.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= tshark(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/udpdump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= udpdump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/wifidump.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= wifidump(1)
:doctype: manpage
:stylesheet: ws.css

2
doc/wireshark-filter.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= wireshark-filter(4)
:doctype: manpage
:stylesheet: ws.css

2
doc/wireshark.adoc
View File

@ -1,4 +1,4 @@
include::../docbook/attributes.adoc[]
include::attributes.adoc[]
= wireshark(1)
:doctype: manpage
:stylesheet: ws.css

2
docbook/CMakeLists.txt
View File

@ -334,7 +334,7 @@ ADD_CUSTOM_COMMAND(
set( WSDG_BUILT_DEPS copy_ws.css wsluarm )
set( ASCIIDOC_CONF_FILES
attributes.adoc
${CMAKE_SOURCE_DIR}/doc/attributes.adoc
# XXX Add macros
)

2
docbook/wsdg_src/developer-guide.adoc
View File

@ -1,5 +1,5 @@
:doctype: book
include::../attributes.adoc[]
include::../../doc/attributes.adoc[]
// Electronic book attributes
:author: Ulf Lamping, Graham Bloice

2
docbook/wsug_src/user-guide.adoc
View File

@ -1,5 +1,5 @@
:doctype: book
include::../attributes.adoc[]
include::../../doc/attributes.adoc[]
// Electronic book attributes
:author: Richard Sharpe, Ed Warnicke, Ulf Lamping

2
packaging/macosx/Donate_to_the_Wireshark_Foundation.adoc
View File

@ -2,7 +2,7 @@
// include-dir
include::{include-dir}/attributes.adoc[]
:stylesheet: {include-dir}/ws.css
:stylesheet: {include-dir}/../docbook/ws.css
== The Wireshark Founation

2
packaging/macosx/Logray_dsym_installation.adoc
View File

@ -2,7 +2,7 @@
// include-dir
include::{include-dir}/attributes.adoc[]
:stylesheet: {include-dir}/ws.css
:stylesheet: {include-dir}/../docbook/ws.css
== Debugging Symbols for Logray

2
packaging/macosx/Logray_read_me_first.adoc
View File

@ -3,7 +3,7 @@
// min-macos-version
include::{include-dir}/attributes.adoc[]
:stylesheet: {include-dir}/ws.css
:stylesheet: {include-dir}/../docbook/ws.css
== Before You Begin

2
packaging/macosx/Wireshark_dsym_installation.adoc
View File

@ -2,7 +2,7 @@
// include-dir
include::{include-dir}/attributes.adoc[]
:stylesheet: {include-dir}/ws.css
:stylesheet: {include-dir}/../docbook/ws.css
== Debugging Symbols for Wireshark

2
packaging/macosx/Wireshark_read_me_first.adoc
View File

@ -3,7 +3,7 @@
// min-macos-version
include::{include-dir}/attributes.adoc[]
:stylesheet: {include-dir}/ws.css
:stylesheet: {include-dir}/../docbook/ws.css
== Before You Begin

6
tools/make-version.py
View File

@ -110,9 +110,9 @@ def create_version_file(version_f, repo_data):
def update_attributes_asciidoc(src_dir, repo_data):
# Read docbook/attributes.adoc, then write it back out with an updated
# Read doc/attributes.adoc, then write it back out with an updated
# wireshark-version replacement line.
asiidoc_filepath = os.path.join(src_dir, "docbook", "attributes.adoc")
asiidoc_filepath = os.path.join(src_dir, "doc", "attributes.adoc")
with open(asiidoc_filepath, encoding='utf-8') as fh:
asciidoc_contents = fh.read()
@ -418,7 +418,7 @@ def read_repo_info(src_dir, tagged_version_extra, untagged_version_extra):
def main():
parser = argparse.ArgumentParser(description='Wireshark file and package versions')
action_group = parser.add_mutually_exclusive_group()
action_group.add_argument('--set-version', '-v', metavar='<x.y.z>', type=parse_versionstring, help='Set the major, minor, and patch versions in the top-level CMakeLists.txt, docbook/attributes.adoc, packaging/debian/changelog, and the CMakeLists.txt for all libraries to the provided version number')
action_group.add_argument('--set-version', '-v', metavar='<x.y.z>', type=parse_versionstring, help='Set the major, minor, and patch versions in the top-level CMakeLists.txt, doc/attributes.adoc, packaging/debian/changelog, and the CMakeLists.txt for all libraries to the provided version number')
action_group.add_argument('--set-release', '-r', action='store_true', help='Set the extra release information in the top-level CMakeLists.txt based on either default or command-line specified options.')
setrel_group = parser.add_argument_group()
setrel_group.add_argument('--tagged-version-extra', '-t', default="", help="Extra version information format to use when a tag is found. No format \