osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity
wireshark/docbook/developer-guide.asciidoc

60 lines
1.5 KiB
Plaintext
Raw Normal View History

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
= Wireshark Developer’s Guide
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
AsciiDoc: Create an include file for attributes. Move the replacement definitions in asciidoc.conf to attributes.asciidoc. This makes the markup a bit cleaner and is more compatible with AsciiDoctor. Use a standard naming scheme for URLs. Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f Reviewed-on: https://code.wireshark.org/review/18655 Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-11-01 21:35:29 +00:00
include::attributes.asciidoc[]
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
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
// Convenience attribute.
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_*
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
include::wsdg_src/WSDG_preface.asciidoc[]
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
include::common_src/typographic_conventions.asciidoc[]
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
[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.
--
include::wsdg_src/WSDG_chapter_env_intro.asciidoc[]
include::wsdg_src/WSDG_chapter_quick_setup.asciidoc[]
include::wsdg_src/WSDG_chapter_sources.asciidoc[]
include::wsdg_src/WSDG_chapter_tools.asciidoc[]
include::wsdg_src/WSDG_chapter_libraries.asciidoc[]
[[PartDevelopment]]
= Wireshark Development
[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.
--
include::wsdg_src/WSDG_chapter_works.asciidoc[]
include::wsdg_src/WSDG_chapter_build_intro.asciidoc[]
include::wsdg_src/WSDG_chapter_capture.asciidoc[]
include::wsdg_src/WSDG_chapter_dissection.asciidoc[]
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
include::wsluarm.asciidoc[]
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
include::wsdg_src/WSDG_chapter_userinterface.asciidoc[]
Docbook: Fix a couple of include paths. Change-Id: I1b06658f516a17516782df57943d7082badba755 Reviewed-on: https://code.wireshark.org/review/23182 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-23 18:49:28 +00:00
include::common_src/GPL_appendix.asciidoc[]