osmocom
/
wireshark
14
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
wireshark/docbook/wsdg_src/WSDG_chapter_build_intro.adoc

53 lines
1.3 KiB
Plaintext
Raw Normal View History

AsciiDoc: Convert some comments. Convert some passthrough XML comments left over from the DocBook → AsciiDoc conversion to AsciiDoc / Asciidoctor comments. Change-Id: Iaf44bcf0b8a3a383e735b2b4394722cbbb2bdff3 Reviewed-on: https://code.wireshark.org/review/25615 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 16:59:45 +00:00
// WSDG Chapter Build Introduction
README.dissector was split from README.developer in 2013 - update some documents referring to the split out sections. Remove trailing whitespace while at this. Change-Id: I36cfe0ac55e8f653bffbf850e01f582aacf85557 Reviewed-on: https://code.wireshark.org/review/4094 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-09-13 05:31:14 +00:00
Docs: Use modern Asciidoctor section IDs. Change our legacy block anchors to section IDs as described at https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
2022-01-16 18:55:52 +00:00
[#ChapterBuildIntro]
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
== Introduction
Docs: Use modern Asciidoctor section IDs. Change our legacy block anchors to section IDs as described at https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
2022-01-16 18:55:52 +00:00
[#ChCodeOverview]
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
=== Source overview
Wireshark consists of the following major parts:
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
* Packet dissection - in the _/epan/dissectors_ and
_/plugins/epan/{asterisk}_ directories
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Slight fixup for where the capture code lives. The full explanation is a bit more complicated - we'd have to mention the dumpcap/*shark split, and the code on both sides of the split. Change-Id: I43f8fc3c589bdf900e20714b55a3b4f544879bc2 Reviewed-on: https://code.wireshark.org/review/31349 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-03 21:56:15 +00:00
* Capture file I/O - using Wireshark’s own wiretap library
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Slight fixup for where the capture code lives. The full explanation is a bit more complicated - we'd have to mention the dumpcap/*shark split, and the code on both sides of the split. Change-Id: I43f8fc3c589bdf900e20714b55a3b4f544879bc2 Reviewed-on: https://code.wireshark.org/review/31349 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-01-03 21:56:15 +00:00
* Capture - using the libpcap and Npcap libraries, in _dumpcap.c_ and
Merge the caputils/ and capchild/ directories The distinction between the different kinds of capture utility may not warrant a special subfolfer for each, and sometimes the distinction is not be clear or some functions could stradle multiple "categories" (like capture_ifinfo.[ch]). Simplify by having only a generic 'capture' subfolder. The separate CMake libraries are kept as a way to reuse object code efficiently.
2021-03-24 22:09:19 +00:00
the _/capture_ directory
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
* User interface - using Qt and associated libraries
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
* Utilities - miscellaneous helper code
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
* Help - using an external web browser and text output
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Docs: Use modern Asciidoctor section IDs. Change our legacy block anchors to section IDs as described at https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
2022-01-16 18:55:52 +00:00
[#ChCodeStyle]
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
=== Coding Style
README.developer: Note that sources can use UTF-8. We started allowing source files to be encoded as UTF-8 in April 2019 in bd75f5af0a. Update README.developer to match. README.developer no longer has a "Code style" section, so update the Developer's Guide to point to the "Portability" section.
2020-09-04 01:40:36 +00:00
The coding style guides for Wireshark can be found in the “Portability”
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
section of the file _doc/README.developer_.
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Docs: Use modern Asciidoctor section IDs. Change our legacy block anchors to section IDs as described at https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
2022-01-16 18:55:52 +00:00
[#ChCodeGLib]
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
=== The GLib library
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
GLib is used as a basic platform abstraction library. It doesn't provide
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
any direct GUI functionality.
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
To quote the GLib Reference Manual:
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
____
GLib provides the core application building blocks for libraries and
applications written in C. It provides the core object system used in GNOME, the
main loop implementation, and a large set of utility functions for strings and
common data structures.
____
GLib contains lots of useful things for platform independent development.
Update a bunch of GLib documentation links. Change our developer.gnome.org/glib URLs to developer-old.gnome.org/glib. The official documentation for GLib appears to be at https://docs.gtk.org/glib/, but it has a different layout than the gnome.org content (and is surprisingly resistant to exploration IMHO). We can switch to developer-old.gnome.org using a simple substitution and it still seems to be updated, so do that for now.
2021-11-20 16:46:50 +00:00
See https://developer.gnome.org/glib/ and https://docs.gtk.org/glib/ for details about GLib.
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
AsciiDoc: Convert some comments. Convert some passthrough XML comments left over from the DocBook → AsciiDoc conversion to AsciiDoc / Asciidoctor comments. Change-Id: Iaf44bcf0b8a3a383e735b2b4394722cbbb2bdff3 Reviewed-on: https://code.wireshark.org/review/25615 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 16:59:45 +00:00
// End of WSDG Chapter Build Introduction