Skip to content

Commit ce06a01

Browse files
JarryShawJarryShaw
authored
docs(protocols): second-round pass over the protocol pages (#719) (#1086)
- ftp, rarp, arp, ngap, esp, protocol: drop "contains X only" where the module defines more (FTP_DATA, DRARP, InARP, the NGAP enums, the ESP SA/algorithm types, ProtocolBase/ProtocolMeta); protocol.rst now says to inherit Protocol directly only for a new protocol stack, a layer base otherwise, and that the built-in families derive from ProtocolBase - ipx: the checksum field is ipx.chksum, not ipx.cksum - mh: drop the stale todo; the CGA Parameters option (type 12) is registered to _read_opt_cga_param/_make_opt_cga_param - index: add NGAP to the class-hierarchy graph and group the click targets of the application-layer classes together - application/index: fix the APPTYPE alias target to pcapkit.const.reg.apptype.apptype.AppType (was unresolved) - misc/index: name PCAPNG alongside the PCAP header classes - c_tag, s_tag: list id() among the identity members each tag adds sphinx -b dummy -n: 1 -> 0 warnings on these pages, none new; tests/project passes.
1 parent 48cdb58 commit ce06a01

13 files changed

Lines changed: 43 additions & 29 deletions

File tree

‎docs/source/pcapkit/protocols/application/ftp.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ FTP - File Transfer Protocol
44
.. module:: pcapkit.protocols.application.ftp
55

66
:mod:`pcapkit.protocols.application.ftp` contains
7-
:class:`~pcapkit.protocols.application.ftp.FTP` only,
7+
:class:`~pcapkit.protocols.application.ftp.FTP`,
88
which implements extractor for File Transfer Protocol
9-
(FTP) [*]_.
9+
(FTP) [*]_, and :class:`~pcapkit.protocols.application.ftp.FTP_DATA`
10+
for its data channel.
1011

1112
.. autoclass:: pcapkit.protocols.application.ftp.FTP
1213
:no-members:

‎docs/source/pcapkit/protocols/application/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ Protocol Registry
3232

3333
.. data:: pcapkit.protocols.application.APPTYPE
3434

35-
alias of :class:`pcapkit.const.reg.apptype.AppType`
35+
alias of :class:`pcapkit.const.reg.apptype.apptype.AppType`

‎docs/source/pcapkit/protocols/application/ngap.rst‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@ NGAP - NG Application Protocol
44
.. module:: pcapkit.protocols.application.ngap
55

66
:mod:`pcapkit.protocols.application.ngap` contains
7-
:class:`~pcapkit.protocols.application.ngap.NGAP` only,
7+
:class:`~pcapkit.protocols.application.ngap.NGAP`,
88
which implements extractor for the NG Application Protocol
9-
(NGAP) [*]_, as specified in 3GPP TS 38.413.
9+
(NGAP) [*]_, as specified in 3GPP TS 38.413, and the four enumerations its
10+
data models report with:
11+
:class:`~pcapkit.protocols.application.ngap.PDUKind`,
12+
:class:`~pcapkit.protocols.application.ngap.Criticality`,
13+
:class:`~pcapkit.protocols.application.ngap.ProcedureCode` and
14+
:class:`~pcapkit.protocols.application.ngap.ProtocolIE`.
1015

1116
NGAP is the control plane between a 5G RAN node (gNB or ng-eNB) and an AMF.
1217
It runs over SCTP and is named by the DATA chunk's *payload protocol

‎docs/source/pcapkit/protocols/application/rarp.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ RARP/DRARP - (Dynamic) Reverse Address Resolution Protocol
44
.. module:: pcapkit.protocols.application.rarp
55

66
:mod:`pcapkit.protocols.application.rarp` contains
7-
:class:`~pcapkit.protocols.application.rarp.RARP` only,
8-
which implements extractor for (Dynamic) Reverse
7+
:class:`~pcapkit.protocols.application.rarp.RARP` and
8+
:class:`~pcapkit.protocols.application.rarp.DRARP`,
9+
which implement extractors for (Dynamic) Reverse
910
Address Resolution Protocol (RARP/DRARP) [*]_,
1011
whose structure is described as below:
1112

‎docs/source/pcapkit/protocols/index.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
6363
end
6464

6565
subgraph application [Application Layer]
66-
Application --> HTTP & FTP & OSPF & RARP
66+
Application --> HTTP & FTP & NGAP & OSPF & RARP
6767

6868
subgraph http [HTTP Family]
6969
HTTP --> h1["HTTP/1.*"] & h2["HTTP/2"]
@@ -108,14 +108,11 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
108108
click Ethernet "/pcapkit/protocols/link/ethernet.html#pcapkit.protocols.link.ethernet.Ethernet"
109109
click L2TP "/pcapkit/protocols/link/l2tp.html#pcapkit.protocols.link.l2tp.L2TP"
110110
click L2TPv2 "/pcapkit/protocols/link/l2tpv2.html#pcapkit.protocols.link.l2tpv2.L2TPv2"
111-
click OSPF "/pcapkit/protocols/application/ospf.html#pcapkit.protocols.application.ospf.OSPF"
112111
click VLAN "/pcapkit/protocols/link/vlan.html#pcapkit.protocols.link.vlan.VLAN"
113112
click C_Tag "/pcapkit/protocols/link/c_tag.html#pcapkit.protocols.link.c_tag.C_Tag"
114113
click S_Tag "/pcapkit/protocols/link/s_tag.html#pcapkit.protocols.link.s_tag.S_Tag"
115114
click ARP "/pcapkit/protocols/link/arp.html#pcapkit.protocols.link.arp.ARP"
116115
click InARP "/pcapkit/protocols/link/arp.html#pcapkit.protocols.link.arp.InARP"
117-
click RARP "/pcapkit/protocols/application/rarp.html#pcapkit.protocols.application.rarp.RARP"
118-
click DRARP "/pcapkit/protocols/application/rarp.html#pcapkit.protocols.application.rarp.DRARP"
119116

120117
click Internet "/pcapkit/protocols/internet/internet.html#pcapkit.protocols.internet.internet.Internet"
121118
click AH "/pcapkit/protocols/internet/ah.html#pcapkit.protocols.internet.ah.AH"
@@ -143,6 +140,10 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
143140
click h2 "/pcapkit/protocols/application/httpv2.html#pcapkit.protocols.application.httpv2.HTTP"
144141
click FTP "/pcapkit/protocols/application/ftp.html#pcapkit.protocols.application.ftp.FTP"
145142
click FTP_DATA "/pcapkit/protocols/application/ftp.html#pcapkit.protocols.application.ftp.FTP_DATA"
143+
click NGAP "/pcapkit/protocols/application/ngap.html#pcapkit.protocols.application.ngap.NGAP"
144+
click OSPF "/pcapkit/protocols/application/ospf.html#pcapkit.protocols.application.ospf.OSPF"
145+
click RARP "/pcapkit/protocols/application/rarp.html#pcapkit.protocols.application.rarp.RARP"
146+
click DRARP "/pcapkit/protocols/application/rarp.html#pcapkit.protocols.application.rarp.DRARP"
146147

147148
click Raw "/pcapkit/protocols/misc/raw.html#pcapkit.protocols.misc.raw.Raw"
148149
click NoPayload "/pcapkit/protocols/misc/null.html#pcapkit.protocols.misc.null.NoPayload"

‎docs/source/pcapkit/protocols/internet/esp.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ ESP - Encapsulating Security Payload
44
.. module:: pcapkit.protocols.internet.esp
55

66
:mod:`pcapkit.protocols.internet.esp` contains
7-
:class:`~pcapkit.protocols.internet.esp.ESP` only,
7+
:class:`~pcapkit.protocols.internet.esp.ESP`,
88
which implements extractor for Encapsulating
9-
Security Payload (ESP) [*]_, whose structure is
10-
described as below:
9+
Security Payload (ESP) [*]_, and the security association, algorithm and
10+
status types documented below. The ESP structure is described as below:
1111

1212
======= ========= ===================== ==============================================
1313
Octets Bits Name Description

‎docs/source/pcapkit/protocols/internet/ipx.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ as below:
1212
======= ========= ====================== =====================================
1313
Octets Bits Name Description
1414
======= ========= ====================== =====================================
15-
0 0 ``ipx.cksum`` Checksum
15+
0 0 ``ipx.chksum`` Checksum
1616
2 16 ``ipx.len`` Packet Length (header includes)
1717
4 32 ``ipx.count`` Transport Control (hop count)
1818
5 40 ``ipx.type`` Packet Type

‎docs/source/pcapkit/protocols/internet/mh.rst‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,6 @@ Octets Bits Name Description
1919
6 48 ``mh.data`` Message Data
2020
======= ========= ================== ===============================
2121

22-
.. todo::
23-
24-
The CGA Parameters option (type 12) is the one registered mobility option
25-
still on the generic handler. It is unreachable rather than unimplemented --
26-
see the Mobility Header section of :doc:`/contributing/pep` for the two faults involved,
27-
both of which are in shared field machinery rather than here.
28-
2922
.. autoclass:: pcapkit.protocols.internet.mh.MH
3023
:no-members:
3124
:show-inheritance:

‎docs/source/pcapkit/protocols/link/arp.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ ARP/InARP - (Inverse) Address Resolution Protocol
44
.. module:: pcapkit.protocols.link.arp
55

66
:mod:`pcapkit.protocols.link.arp` contains
7-
:class:`~pcapkit.protocols.link.arp.ARP` only,
8-
which implements extractor for (Inverse) Address Resolution
7+
:class:`~pcapkit.protocols.link.arp.ARP` and
8+
:class:`~pcapkit.protocols.link.arp.InARP`,
9+
which implement extractors for (Inverse) Address Resolution
910
Protocol (ARP/InARP) [*]_, whose structure is described as
1011
below:
1112

‎docs/source/pcapkit/protocols/link/c_tag.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Its structure, and all of its parsing and construction, come from
1212
:class:`~pcapkit.protocols.link.vlan.VLAN`; this class adds only the tag's own
1313
identity -- :attr:`~pcapkit.protocols.link.c_tag.C_Tag.name`,
1414
:attr:`~pcapkit.protocols.link.c_tag.C_Tag.alias`,
15-
:attr:`~pcapkit.protocols.link.c_tag.C_Tag.info_name` -- and its registry index.
15+
:attr:`~pcapkit.protocols.link.c_tag.C_Tag.info_name`,
16+
:meth:`~pcapkit.protocols.link.c_tag.C_Tag.id` -- and its registry index.
1617

1718
It has a module of its own, apart from
1819
:class:`~pcapkit.protocols.link.s_tag.S_Tag`, because the two are reached through

0 commit comments

Comments
 (0)