summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDenis Ovsienko <denis@ovsienko.info>2021-11-03 11:08:26 +0000
committerDenis Ovsienko <denis@ovsienko.info>2021-11-03 11:08:26 +0000
commit4a8640f5d27e0df51ca95177de7909fac4258990 (patch)
tree3849a58045ecb3f3f237e82d1f9c61ff20a15caf /doc
parent56c60dd660297b5cf02afcb9fdc4f92689de0353 (diff)
downloadlibpcap-4a8640f5d27e0df51ca95177de7909fac4258990.tar.gz
doc: Refine Markdown in DLT_ALLOCATE_HOWTO.md. [skip ci]
Diffstat (limited to 'doc')
-rw-r--r--doc/DLT_ALLOCATE_HOWTO.md33
1 files changed, 16 insertions, 17 deletions
diff --git a/doc/DLT_ALLOCATE_HOWTO.md b/doc/DLT_ALLOCATE_HOWTO.md
index ff77128e..0e2dbe9f 100644
--- a/doc/DLT_ALLOCATE_HOWTO.md
+++ b/doc/DLT_ALLOCATE_HOWTO.md
@@ -1,29 +1,28 @@
-DLT and LINKTYPE allocation
-===========================
+# DLT and LINKTYPE allocation
-DLT_ types live in pcap/dlt.h. They can be requested by the community on a
-First-Come First-Served basis [i.e. https://tools.ietf.org/html/rfc8126#section-4.4 ]
+DLT_ types live in `pcap/dlt.h`. They can be requested by the community on a
+[First-Come First-Served](https://tools.ietf.org/html/rfc8126#section-4.4) basis.
(Although libpcap is not at this time an IETF specification, there have been
some as yet-incomplete efforts to do this).
-The Tcpdump Group prefers to link to an open specification on the new DLT_
+The Tcpdump Group prefers to link to an open specification on the new `DLT_`
type, but they are available for closed, proprietary projects as well.
In that case, a stable email address suffices so that someone who finds
-an unknown DLT_ type can investigate.
+an unknown `DLT_` type can investigate.
+
We prefer to give out unambiguous numbers, and we try to do it as quickly
-as possible, but DLT_USERx is available while you wait.
+as possible, but `DLT_USERx` is available while you wait.
-Note that DLT_ types are, in theory, private to the capture mechanism and can
+Note that `DLT_` types are, in theory, private to the capture mechanism and can
in some cases be operating system specific, and so a second set of values,
-LINKTYPE_ is allocated for actually writing to pcap files. As much as
-possible going forward, the DLT_ and LINKTYPE_ value are identical, however,
-this was not always the case. See pcap-common.c.
+`LINKTYPE_` is allocated for actually writing to pcap files. As much as
+possible going forward, the `DLT_` and `LINKTYPE_` value are identical, however,
+this was not always the case. See `pcap-common.c`.
-The LINKTYPE_ values are not exported, but are in pcap-common.c only.
+The `LINKTYPE_` values are not exported, but are in `pcap-common.c` only.
-DEVELOPER NOTES
----------------
+## DEVELOPER NOTES
-When allocating a new DLT_ value, a corresponding value needs to be
-added to pcap-common.c.
-It is not necessary to copy the comments from dlt.h to pcap-common.c.
+When allocating a new `DLT_` value, a corresponding value needs to be
+added to `pcap-common.c`.
+It is not necessary to copy the comments from `dlt.h` to `pcap-common.c`.