Skip to content

Commit

Permalink
Docs: Move the User's and Developer's Guides to the doc directory
Browse files Browse the repository at this point in the history
The documentation was originally kept in the "docbook" directory because
it was written in the DocBook markup language. That hasn't been the case
for a long time, so just move everything under "doc".

Move make-wsluarm.py to the tools directory.
  • Loading branch information
geraldcombs authored and AndersBroman committed Jul 25, 2024
1 parent ea842c8 commit 54d279d
Show file tree
Hide file tree
Showing 282 changed files with 481 additions and 578 deletions.
9 changes: 4 additions & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1698,7 +1698,6 @@ set(PLUGIN_INSTALL_VERSION_LIBDIR "${PLUGIN_INSTALL_LIBDIR}/${PLUGIN_PATH_ID}")
set(PLUGIN_VERSION_DIR "plugins/${PLUGIN_PATH_ID}")

add_subdirectory( capture )
add_subdirectory( doc )
add_subdirectory( epan )
add_subdirectory( extcap )
add_subdirectory( randpkt_core )
Expand Down Expand Up @@ -1754,9 +1753,9 @@ endif()
# learn about the directory location.
add_subdirectory( wsutil )

# docbook must be added after DATAFILE_DIR is set so that the guides can be
# doc/ must be added after DATAFILE_DIR is set so that the guides can be
# copied there for running from the build directory
add_subdirectory( docbook EXCLUDE_FROM_ALL )
add_subdirectory( doc EXCLUDE_FROM_ALL )

if(BUILD_wireshark AND QT_FOUND)
add_subdirectory( ui/qt )
Expand Down Expand Up @@ -4091,13 +4090,13 @@ install(

if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE)
install(
DIRECTORY "${CMAKE_BINARY_DIR}/docbook/wsug_html_chunked"
DIRECTORY "${CMAKE_BINARY_DIR}/doc/wsug_html_chunked"
DESTINATION "${CMAKE_INSTALL_DOCDIR}"
COMPONENT "UserGuide"
EXCLUDE_FROM_ALL
)
install(
DIRECTORY "${CMAKE_BINARY_DIR}/docbook/wsdg_html_chunked"
DIRECTORY "${CMAKE_BINARY_DIR}/doc/wsdg_html_chunked"
DESTINATION "${CMAKE_INSTALL_DOCDIR}"
COMPONENT "DeveloperGuide"
EXCLUDE_FROM_ALL
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ Complete details on doing so can be found in the [Developer’s Guide](https://w
When you submit a merge request, a series of automated tests will be run in order to ensure that compiles across different platforms and conforms to our coding guidelines.
The change will also be manually reviewed by a core developer and will be merged when the change passes both automated and manual review.

The Wireshark User’s Guide and Developer’s Guide are maintained in the [docbook directory](https://gitlab.com/wireshark/wireshark/-/tree/master/docbook) in the main repository.
The Wireshark User’s Guide and Developer’s Guide are maintained in the [doc directory](https://gitlab.com/wireshark/wireshark/-/tree/master/doc) in the main repository.
You don’t need a complete development environment to contribute to them, but you do need git and a text editor.
Documentation updates must be made via a merge request similar to source code changes.
2 changes: 1 addition & 1 deletion INSTALL
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
See also https://gitlab.com/wireshark/wireshark/-/wikis/Development
and the Developer's Guide located at https://www.wireshark.org/docs/
and in the docbook/ subdirectory.
and in the doc/ subdirectory.

Installation
============
Expand Down
2 changes: 1 addition & 1 deletion README.bsd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installing Wireshark on FreeBSD/OpenBSD/NetBSD/DragonFly BSD

For general installation instructions, see the INSTALL file, along with
the Developer's Guide located at https://www.wireshark.org/docs/ and
in the docbook/ directory. Additional BSD specific notes and requirements
in the doc/ directory. Additional BSD specific notes and requirements
follow.

1. Berkeley Packet Filter (BPF) requirement
Expand Down
2 changes: 1 addition & 1 deletion cmake/modules/FindAsciidoctor.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ if(ASCIIDOCTOR_EXECUTABLE)
# --failure-level=WARN
# --trace
--quiet
--attribute build_dir=${CMAKE_BINARY_DIR}/docbook
--attribute build_dir=${CMAKE_BINARY_DIR}/doc
--attribute css_dir=${CMAKE_SOURCE_DIR}/doc
--require ${CMAKE_SOURCE_DIR}/doc/asciidoctor-macros/ws_utils.rb
--require ${CMAKE_SOURCE_DIR}/doc/asciidoctor-macros/commaize-block.rb
Expand Down
2 changes: 1 addition & 1 deletion cmake/modules/FindXSLTPROC.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources)
SET(_modeparams --stringparam chunker.output.encoding UTF-8 --stringparam chunk.quietly 1)
ELSE() # single-page
SET(_basedir ${_dir_pfx}_html)
SET(_stylesheet ${CMAKE_SOURCE_DIR}/docbook/custom_layer_single_html.xsl)
SET(_stylesheet ${CMAKE_SOURCE_DIR}/doc/custom_layer_single_html.xsl)
SET(_modeparams --output ${_basedir}/index.html)
ENDIF()

Expand Down
Loading

0 comments on commit 54d279d

Please sign in to comment.