Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/contributing/conventions/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,15 @@ settled this on :issue:`719` found exactly one, and repeating it is cheap:
[ -f "$path.py" ] || [ -f "$path/__init__.py" ] || echo "dangling: $path"
done

**Under a** ``.. module::``, **a hand-written** ``.. data::`` **or** ``.. function::``
**takes the bare name.** The module directive already supplies the prefix, so
``.. data:: pcapkit.x._T`` under ``.. module:: pcapkit.x`` registers
``pcapkit.x.pcapkit.x._T``, which no reference resolves to exactly. Where the object
lives in a module other than the current one, a ``:module:`` option names it, as the
``LINKTYPE`` entry on :doc:`/pcapkit/protocols/link/index` does. :issue:`1775` found 44
directives spelled the long way, which left seven TypeVar references ambiguous;
:file:`tests/project/test_docs_ambiguous_xrefs_1775_unit.py` fails on the next one.

**Every importable shipped module is documented, with one deliberate exception.** The 33
modules under :file:`pcapkit/protocols/*/NotImplemented/` are the set with no entry:
placeholder sources for dissectors nobody has written yet, carrying no class a reader
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/conventions/mint-criterion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ a ``_missing_`` override, which decides what happens when a value has no member.
MRO, so they carry no declared-but-unassigned range to resolve. 121 define one
themselves; the other four are the transport subclasses of
:class:`~pcapkit.const.reg.apptype.apptype.AppType`, which inherit
``AppType._missing_`` (:file:`pcapkit/const/reg/apptype/apptype.py:2936`). Three
``AppType._missing_`` (:file:`pcapkit/const/reg/apptype/apptype.py:2958`). Three
behaviours follow from it, and which one a given range gets is a **design decision, not
a style preference**:

Expand Down
2 changes: 2 additions & 0 deletions docs/source/ext.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ The protocol classes :mod:`pcapkit` ships:
+ + +-----------------------+-------------------------------------------------------------+
| | | :class:`pcapkit.protocols.internet.ipv6.IPv6` |
+ + +-----------------------+-------------------------------------------------------------+
| | | | :class:`pcapkit.protocols.internet.ipv6_ext.IPv6_Ext` |
+ + + +-------------------------------------------------------------+
| | | | :class:`pcapkit.protocols.internet.ipv6_frag.IPv6_Frag` |
+ + + +-------------------------------------------------------------+
| | | | :class:`pcapkit.protocols.internet.ipv6_opts.IPv6_Opts` |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Installation
is intent rather than something that works. ``bpc-poseur`` 0.4.3.post1 crashes
on positional-only parameters declared on a *method* rather than a plain
function, and exits 0 so the build does not notice; such methods -- including
the 13 on :class:`~pcapkit.corekit.io.SeekableReader`, plus a dozen more across
the 14 on :class:`~pcapkit.corekit.io.SeekableReader`, plus a dozen more across
the protocols, foundation, dumpkit and corekit modules -- then survive into the
installed package and ``import pcapkit`` fails with :exc:`SyntaxError`.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/pcapkit/dumpkit/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ alike those in :mod:`dictdumper`.
.. toctree::
:maxdepth: 2

common
pcap
null
common

Every dumper class is a :class:`dictdumper.dumper.Dumper` subclass, responsible
for writing parsed packet data into a formatted output file. The class
Expand Down
6 changes: 6 additions & 0 deletions docs/source/pcapkit/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,12 @@ Command Line Tool
The name of buffer storage file. If `--buffer-save` is
set and this omits, it will be automatically assigned.

.. versionchanged:: 1.5.0

``-P`` and ``-L`` stop the extraction where they say, which 1.4.x ignored, and
``-L`` accepts only ``link``, ``internet``, ``transport``, ``application`` or
``none``, in any case (:issue:`356`).

Environment Variables
=====================

Expand Down
14 changes: 8 additions & 6 deletions docs/source/pcapkit/protocols/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,18 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
end

subgraph internet [Internet Layer]
Internet --> HIP & IPX & IP & ipv6ext
Internet --> IPX & IP & IPsec & IPv6_Ext

subgraph ip [IP Family]
IP --> IPv4 & IPv6 & IPsec
IP --> IPv4 & IPv6
end

subgraph ipsec [IPsec Family]
IPsec --> AH & ESP
end
subgraph ipsec [IPsec Family]
IPsec --> AH & ESP
end

subgraph ipv6ext [IPv6 Extension Header]
IPv6-Frag & IPv6-Opts & IPv6-Route & HOPOPT & MH
IPv6_Ext --> IPv6-Frag & IPv6-Opts & IPv6-Route & HOPOPT & MH & HIP
end
end

Expand Down Expand Up @@ -95,6 +95,7 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
B --> Header & Frame & PCAPNG & Raw & NoPayload
Raw --> FTP_DATA
ARP --> RARP
IPv6_Ext --> AH & ESP

B --> C(Protocol)
C --> D([user customisation ...])
Expand Down Expand Up @@ -124,6 +125,7 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
click IPsec "/pcapkit/protocols/internet/ipsec.html#pcapkit.protocols.internet.ipsec.IPsec"
click IPv4 "/pcapkit/protocols/internet/ipv4.html#pcapkit.protocols.internet.ipv4.IPv4"
click IPv6 "/pcapkit/protocols/internet/ipv6.html#pcapkit.protocols.internet.ipv6.IPv6"
click IPv6_Ext "/pcapkit/protocols/internet/ipv6_ext.html#pcapkit.protocols.internet.ipv6_ext.IPv6_Ext"
click IPv6-Frag "/pcapkit/protocols/internet/ipv6_frag.html#pcapkit.protocols.internet.ipv6_frag.IPv6_Frag"
click IPv6-Opts "/pcapkit/protocols/internet/ipv6_opts.html#pcapkit.protocols.internet.ipv6_opts.IPv6_Opts"
click IPv6-Route "/pcapkit/protocols/internet/ipv6_route.html#pcapkit.protocols.internet.ipv6_route.IPv6_Route"
Expand Down
2 changes: 1 addition & 1 deletion docs/source/pcapkit/vendor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,6 @@ constant enumerations.
positional arguments:
target update targets, supply none to update all

optional arguments:
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
Loading