osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
wireshark/docbook/developer-guide.adoc

68 lines
1.6 KiB
Plaintext
Raw Normal View History

Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
//v1.0, February 2014: Finished conversion from DocBook to AsciiDoc
:doctype: book
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::attributes.adoc[]
Documentation: Add version to Guides Previously, before the AsciiDoc conversion, the Users' and Developers' Guide used to carry version information on the title page. This seems to have been dropped, for reasons unknown to me. At least AsciiDoctor allows to add a subtitle, so the wireshark-version attribute can be expanded into it. Change-Id: Ib0a90393aff1a323b7026c49e2aa11f5115b3ec7 Signed-off-by: Jaap Keuter <jaap.keuter@xs4all.nl> Reviewed-on: https://code.wireshark.org/review/28330 Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-06-18 19:44:35 +00:00
= Wireshark Developer’s Guide: Version {wireshark-version}
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
WSDG: Miscellaneous updates and fixes. Update the Windows CRT text to mention the Universal CRT. Replace references to WinPcap with Npcap. Update the Qt LTS text. Add a WiX / .msi section Use curly quotes. Use the {cpp} attribute so that the "++" in "C++" doesn't trigger monospace formatting. Make the various "Unix" and "Windows" subsection title names uniform. Give them the "discrete" attribute so that they don't clutter up the TOC. Title-case section titles. Remove the reference to m4. As far as I can tell we don't require it. Change-Id: I73f851adae640f77205781d6c4962002c2d53f49 Reviewed-on: https://code.wireshark.org/review/31343 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-01-03 20:01:19 +00:00
// Attributes
More AsciiDoc → Asciidoctor updates. Switch from AsciiDoc's smart quotes markup to the quotes themselves. Use double curly quotes in place of singles. Switch from XML entities to their direct equivalents where we can. Switch from hex entities to decimal entities where we can't or it's not convenient. (Asciidoctor PDF doesn't yet handle hex entities). Change-Id: Iaf5ec33249e1c91b3d50b5d96251763243b72836 Reviewed-on: https://code.wireshark.org/review/25606 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 23:15:02 +00:00
// XXX This should be surrounded by single quotes in the text. It’s
Docs: Make our AsciiDoc markup more compatible with AsciiDoctor. Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 19:39:56 +00:00
// currently surrounded by plus signs for AsciiDoc compatibility.
:dlt-glob: DLT_*
WSDG: Update Qt and MSVC versions
2021-05-05 20:37:56 +00:00
:qt-lts-version: 5.15
Docbook: Fix an unterminated tag, other updates. Remove nested example tags from the dissection chapter, including and unbalanced one. Mark our source blocks with [source,c]. Enable syntax highlighting in the Developer's and User's guides. This isn't supported in the DocBook backend (which we use to generate the HTML guides), but it is in the PDF backend. Add a comment about failing on warnings when we generate our guides. Change-Id: Ieee29fe75364ca23769aa997f90126e31b72cc8b Reviewed-on: https://code.wireshark.org/review/36767 Petri-Dish: Guy Harris <gharris@sonic.net> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <gharris@sonic.net> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-04-09 20:54:35 +00:00
:source-highlighter: coderay
Docs: Make our AsciiDoc markup more compatible with AsciiDoctor. Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 19:39:56 +00:00
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
[[Preface]]
["preface",id="Preface"]
WSUG+WSDG: Add a typographic conventions section. Create a common_src directory for common guide content. Add a typographic convention section. Update some of the content accordingly. Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e Reviewed-on: https://code.wireshark.org/review/23131 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-18 19:32:17 +00:00
== Preface
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_preface.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::common_src/typographic_conventions.adoc[]
WSUG+WSDG: Add a typographic conventions section. Create a common_src directory for common guide content. Add a typographic convention section. Update some of the content accordingly. Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e Reviewed-on: https://code.wireshark.org/review/23131 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-08-18 19:32:17 +00:00
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
[[PartEnvironment]]
= Wireshark Build Environment
AsciiDoctor markup updates. Separate includes by blank lines as recommended in https://asciidoctor.org/docs/user-manual/#include-directive. Separate block attributes as well. Change-Id: I933917a14eae6d1fe1879372917ab2208755f470 Reviewed-on: https://code.wireshark.org/review/28769 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-19 20:11:29 +00:00
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
[partintro]
.Wireshark Build Environment
--
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.
--
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_env_intro.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_quick_setup.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_sources.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_tools.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_libraries.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
[[PartDevelopment]]
= Wireshark Development
AsciiDoctor markup updates. Separate includes by blank lines as recommended in https://asciidoctor.org/docs/user-manual/#include-directive. Separate block attributes as well. Change-Id: I933917a14eae6d1fe1879372917ab2208755f470 Reviewed-on: https://code.wireshark.org/review/28769 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-07-19 20:11:29 +00:00
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
[partintro]
.Wireshark Development
--
The second part describes how the Wireshark sources are structured and how to
change the sources such as adding a new dissector.
--
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_works.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_build_intro.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_capture.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_dissection.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsluarm.adoc[]
Convert the Lua reference to AsciiDoc. Move it to the Developer's Guide while we're here. Nudge the markup in epan/wslua where needed. Note that we should probably convert it to AsciiDoc (if we're going to keep it in the DG) or Doxygen. Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b Reviewed-on: https://code.wireshark.org/review/5203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-02 21:20:08 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_userinterface.adoc[]
Finish converting the Developer's Guide to AsciiDoc. Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-09 19:01:49 +00:00
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::wsdg_src/WSDG_chapter_tests.adoc[]
Start porting our test scripts to Python. Add ctest support. Create Python versions of our various test shell scripts. Add CMake tests for each suite. Tests can now be run directly via test.py, via the "test" target, or via ctest, e.g. ctest --verbose --jobs 3 Add a testing chapter to the Developer's Guide. Add a way to disable ctest in dpkg-buildpackage. Suites completed: - capture - clopts - decryption - dissection Remaining suites: - fileformats - io - mergecap - nameres - text2pcap - unittests - wslua Change-Id: I8936e05edefc76a86b6a7a5da302e7461bbdda0f Reviewed-on: https://code.wireshark.org/review/27134 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-03 00:12:23 +00:00
WSDG: Migrate the asn2wrs content from the wiki. Asn2wrs generates quite a bit of our dissector code, so convert some of our asn2wrs wiki pages to a WSDG chapter. Conversion was done using the script below and editing as needed. ---- OUT_ADOC="docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc" cp /dev/null "$OUT_ADOC" PAGES=" Asn2wrs Asn2wrs_Handmassaging_the_ASN_file ASN1_sample Asn2wrsAuxiliary #.END #.EXPORTS #.FN_BODY #.INCLUDE #.MODULE_IMPORT #.NO_EMIT #.PDU #.PDU_NEW #.REGISTER #.REGISTER_NEW #.USER_DEFINED " for PAGE in $PAGES ; do PAGE=${PAGE/\#/%23} curl "https://wiki.wireshark.org/$PAGE" \ | xmllint --html --format --xpath '//div[@id="content"]' - \ | pandoc -f html -t asciidoctor \ | sed -e 's/\[\#[^ ][^ ]* .anchor\]##*//g' -e 's/\[content\]//g' \ | cat -s \ >> "$OUT_ADOC" done ---- Change-Id: Ibc02b7b463dfc37abf5c2fd0a4e66f6161d290f6 Reviewed-on: https://code.wireshark.org/review/36707 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-04-02 17:55:10 +00:00
include::wsdg_src/WSDG_chapter_asn2wrs.adoc[]
Rename our .asciidoc files to .adoc As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-14 23:23:05 +00:00
include::common_src/GPL_appendix.adoc[]