Skip to content

docs(protocols): second pass over HIP, IPv4, IPv6 and IPX (#1103) #1782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JarryShaw merged 2 commits into from
Oct 15, 2026
Merged

docs(protocols): second pass over HIP, IPv4, IPv6 and IPX (#1103) #1782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ca60c0
docs(protocols): second pass over HIP, IPv4, IPv6 and IPX (#1103)
JarryShaw Oct 15, 2026
efea62b
Merge branch 'main' into docs/1103-internet-a
JarryShaw Oct 15, 2026
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
6 changes: 0 additions & 6 deletions docs/source/pcapkit/protocols/internet/internet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,3 @@ behind IPv4, its toolkit steps over them in the octets to find TCP, up to
:data:`~pcapkit.utilities.config.EXTENSION_HEADER_LIMIT` of them in a row. The
``pypcapfile`` toolkit walks no extension header chain, so it finds no upper
layer behind one.

.. versionremoved:: 1.5.0

``pcapkit.protocols.internet.internet.EXTENSION_HEADER_LIMIT``, now
:data:`pcapkit.utilities.config.EXTENSION_HEADER_LIMIT`, set with
:envvar:`PCAPKIT_EXTENSION_HEADER_LIMIT` (:issue:`1726`).
3 changes: 3 additions & 0 deletions docs/source/pcapkit/protocols/internet/ipv6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ Octets Bits Name Description

.. automethod:: __index__

.. autoattribute:: __generic_ext_codes__
:no-value:

Protocol Constants
------------------

Expand Down
15 changes: 11 additions & 4 deletions pcapkit/protocols/data/internet/hip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,14 @@ def __init__(self, type: 'Enum_Parameter', critical: 'bool', length: 'int', inde

@info_final
class SolutionParameter(Parameter):
"""Data model for HIP ``SOLUTION`` parameter."""
"""Data model for HIP ``SOLUTION`` parameter.

.. versionremoved:: 1.5.0

``lifetime``, now :attr:`reserved`: only ``PUZZLE`` carries a lifetime
(:issue:`654`).

"""

#: Numeric index.
index: 'int'
Expand Down Expand Up @@ -431,7 +438,7 @@ def __init__(self, type: 'Enum_Parameter', critical: 'bool', length: 'int', hi_l

@info_final
class HITSuiteListParameter(Parameter):
"""Data model for HIP ``HIST_SUITE_LIST`` parameter."""
"""Data model for HIP ``HIT_SUITE_LIST`` parameter."""

#: Suite IDs.
suite_id: 'tuple[HITSuite, ...]'
Expand Down Expand Up @@ -654,7 +661,7 @@ def __init__(self, type: 'Enum_Parameter', critical: 'bool', length: 'int', id:

@info_final
class OverlayIDParameter(Parameter):
"""Data mode HIP ``OVERLAY_ID`` parameter."""
"""Data model for HIP ``OVERLAY_ID`` parameter."""

#: Identifier.
id: 'int'
Expand All @@ -665,7 +672,7 @@ def __init__(self, type: 'Enum_Parameter', critical: 'bool', length: 'int', id:

@info_final
class Flags(Data):
"""Data model for flags in HIP ``HIP_PARAMETER_FLAGS`` parameter."""
"""Data model for the flags in HIP ``ROUTE_DST`` and ``ROUTE_VIA`` parameters."""

#: Symmetric flag.
symmetric: 'bool'
Expand Down
6 changes: 4 additions & 2 deletions pcapkit/protocols/data/internet/ipv4.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ class ToSField(Data):
"""Data model for IPv4 ToS fields.

Important:
Due to the reserved keyword conflict, please use :meth:`from_dict`
Due to the reserved keyword conflict, please use
:meth:`~pcapkit.corekit.infoclass.Info.from_dict`
to create an instance of this data model.

"""
Expand Down Expand Up @@ -323,7 +324,8 @@ class TROption(Option):
"""Data model for IPv4 Traceroute (``TR``) option.

Important:
Due to the reserved keyword conflict, please use :meth:`from_dict`
Due to the reserved keyword conflict, please use
:meth:`~pcapkit.corekit.infoclass.Info.from_dict`
to create an instance of this data model.

"""
Expand Down
Loading
Loading