aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsdg_src
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2019-01-04 12:00:59 -0800
committerPeter Wu <peter@lekensteyn.nl>2019-01-04 21:49:59 +0000
commit340ad1793b08faa4bfe79fcd2bba80ce68513d42 (patch)
treee6d7a88a214f2c592d14c40e408741adc8f0ee39 /docbook/wsdg_src
parent0eff9103b68b04c2535ade299fce51d8070c7c03 (diff)
Finish migrating to Asciidoctor's modern syntax.
Finish migrating the User's and Developer's guides to modern syntax. Remove :compat-mode: from attributes.asciidoc. Change-Id: I1232676c6ef4c3638253d070dcbae6d3c1ead284 Reviewed-on: https://code.wireshark.org/review/31374 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Peter Wu <peter@lekensteyn.nl>
Diffstat (limited to 'docbook/wsdg_src')
-rw-r--r--docbook/wsdg_src/WSDG_chapter_capture.asciidoc22
-rw-r--r--docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc2
-rw-r--r--docbook/wsdg_src/WSDG_chapter_sources.asciidoc12
3 files changed, 18 insertions, 18 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_capture.asciidoc b/docbook/wsdg_src/WSDG_chapter_capture.asciidoc
index fbda29443b..4e6c55a36b 100644
--- a/docbook/wsdg_src/WSDG_chapter_capture.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_capture.asciidoc
@@ -4,7 +4,7 @@
[[ChapterCapture]]
-== Packet capturing
+== Packet Capture
toc::[]
@@ -14,17 +14,17 @@ This chapter needs to be reviewed and extended.
[[ChCaptureAddLibpcap]]
-=== How to add a new capture type to libpcap
+=== How To Add A New Capture Type To Libpcap
The following is an updated excerpt from a developer mailing list mail about
adding ISO 9141 and 14230 (simple serial line card diagnostics) to Wireshark:
-For libpcap, the first thing you’d need to do would be to get +{dlt-glob}+ values
+For libpcap, the first thing you’d need to do would be to get `{dlt-glob}` values
for all the link-layer protocols you’d need. If ISO 9141 and 14230 use the same
-link-layer protocol, they might be able to share a +{dlt-glob}+ value, unless the
+link-layer protocol, they might be able to share a `{dlt-glob}` value, unless the
only way to know what protocols are running above the link layer is to know
which link-layer protocol is being used, in which case you might want separate
-+{dlt-glob}+ values.
+`{dlt-glob}` values.
For the rest of the libpcap discussion, I'll assume you're working with libpcap
1.0 or later and that this is on a UN*X platform. You probably don't want to
@@ -44,11 +44,11 @@ The serial port open routine would open the serial port device, set the baud
rate and do anything else needed to open the device. It’d allocate a `pcap_t`,
set its `fd` member to the file descriptor for the serial device, set the
`snapshot` member to the argument passed to the open routine, set the `linktype`
-member to one of the +{dlt-glob}+ values, and set the `selectable_fd` member to
+member to one of the `{dlt-glob}` values, and set the `selectable_fd` member to
the same value as the `fd` member. It should also set the `dlt_count` member to
-the number of +{dlt-glob}+ values to support, and allocate an array of
+the number of `{dlt-glob}` values to support, and allocate an array of
`dlt_count` `u_int`s, assign it to the `dlt_list` member, and fill in that list
-with all the +{dlt-glob}+ values.
+with all the `{dlt-glob}` values.
You’d then set the various `_*_op` fields to routines to handle the operations in
question. `read_op` is the routine that’d read packets from the device. `inject_op`
@@ -60,10 +60,10 @@ error. `getnonblock_op` can probably be set to `pcap_getnonblock_fd`. `setnonblo
can probably be set to `pcap_setnonblock_fd`. `stats_op` would be set to a routine
that reports statistics. `close_op` can probably be set to `pcap_close_common`.
-If there’s more than one +{dlt-glob}+ value, you definitely want a `set_datalink`
+If there’s more than one `{dlt-glob}` value, you definitely want a `set_datalink`
routine so that the user can select the appropriate link-layer type.
-For Wireshark, you’d add support for those +{dlt-glob}+ values to
+For Wireshark, you’d add support for those `{dlt-glob}` values to
_wiretap/libpcap.c_, which might mean adding one or more _WTAP_ENCAP_ types to
_wtap.h_ and to the `encap_table[]` table in _wiretap/wtap.c_. You’d then
have to write a dissector or dissectors for the link-layer protocols or
@@ -472,7 +472,7 @@ The protocol used to communicate over the control pipes has a fixed size header
|===
.Sync Pipe Indication:
- The common sync pipe indication. This protocol uses the value 'T'.
+ The common sync pipe indication. This protocol uses the value “T”.
.Message Length:
Payload length + 2 bytes for control number and command.
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
index d83952e5df..ea7deecf5c 100644
--- a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
@@ -533,7 +533,7 @@ If building an x86 version using a Visual Studio “Express” edition or an x64
The files can be located in the Visual Studio install directory for non-Express edition builds, or downloaded from Microsoft for Expresss edition builds.
-Note you must use the correct version of vcredist for your compiler, unfortunately they all have the same name (_vcredist_x86.exe_ or _vcredist_x64.exe_). You can use Windows Explorer and examine the `Properties -> Details' tab for a vcredist file to determine which compiler version the file is for use with.
+Note you must use the correct version of vcredist for your compiler, unfortunately they all have the same name (_vcredist_x86.exe_ or _vcredist_x64.exe_). You can use Windows Explorer and examine the “Properties -> Details” tab for a vcredist file to determine which compiler version the file is for use with.
If you've closed the Visual Studio Command Prompt <<ChSetupPrepareCommandCom,prepare>> it again.
diff --git a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc
index 1810fd168b..012150d24c 100644
--- a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc
@@ -634,7 +634,7 @@ as described at <<ChSrcGit>>.
// patch file.
//
// If you've added a new file, e.g.
-// 'packet-myprotocol.c', you can use `svn add` to add it to your local tree before generating the patch.
+// _packet-myprotocol.c_, you can use `svn add` to add it to your local tree before generating the patch.
// Similarly, you can use `svn rm` for files that should be removed.
[[ChSrcSVNGUIDiff]]
@@ -658,11 +658,11 @@ as described at <<ChSrcGit>>.
// When you create the diff file, it will include any difference TortoiseSVN
// finds in files in and under the directory you have right-clicked on, and
// nothing else. This means that changes you might have made for your
-// specific configuration - like modifying 'config.nmake' so that it uses
+// specific configuration - like modifying _config.nmake_ so that it uses
// your lib directory - will also be included, and you will need to remove
// these lines from the diff file. It also means that only changes will be
// recorded, i.e. if you have created new files -- say, a new
-// 'packet-xxx.c' for a
+// _packet-xxx.c_ for a
// new protocol dissector -- it will not be included in the diff, you need to
// add it separately. And, of course, if you have been working separately in
// two different patches, the .diff file will include both topics, which is
@@ -698,7 +698,7 @@ as described at <<ChSrcGit>>.
// of temporary files which might be otherwise included in the diff. After
// doing the diff, you should edit the _foo.diff_ file and remove unnecessary
// things, like your private changes to the
-// 'config.nmake' file.
+// _config.nmake_ file.
//
//
// .Some useful diff options
@@ -723,7 +723,7 @@ as described at <<ChSrcGit>>.
[[ChSrcGoodPatch]]
-==== Some tips for a good patch
+==== Some Tips For A Good Patch
Some tips that will make the merging of your changes into Git much more likely
(and you want exactly that, don't you?):
@@ -739,7 +739,7 @@ Some tips that will make the merging of your changes into Git much more likely
* _Inspect your patch carefully._ Run `git diff` and make sure you aren't
adding, removing, or omitting anything you shouldn't.
-// * 'Do a "make clean" before generating the patch.' This removes a lot of
+// * _Do a "make clean" before generating the patch._ This removes a lot of
// unneeded intermediate files (like object files) which can confuse the diff
// tool generating a lot of unneeded stuff which you have to remove by hand from
// the patch again.