Skip to content

Commit

Permalink
Standardize terminology for clarity and consistency (value -> integer)
Browse files Browse the repository at this point in the history
s/unsigned value/unsigned integer/g
s/signed value/signed integer/g
s/unsigned integer value/unsigned integer/g
s/signed integer value/signed integer/g
  • Loading branch information
fxlb authored and guyharris committed Jan 12, 2025
1 parent d5d22d9 commit 26341d4
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
16 changes: 8 additions & 8 deletions draft-ietf-opsawg-pcap.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ written on little-endian machines from the ones written on big-endian
machines, and to heuristically identify pcap files.

Major Version (16 bits):
: an unsigned value, giving the number of the current major version of
: an unsigned integer, giving the number of the current major version of
the format. The value for the current version of the format is 2
(big-endian 0x00 0x02 or little-endian 0x02 0x00). This
value should change if the format changes in such a way that code that
Expand All @@ -128,7 +128,7 @@ code paths for the two formats) and code that reads the old format could
not read the new format.

Minor Version (16 bits):
: an unsigned value, giving the number of the current minor version of
: an unsigned integer, giving the number of the current minor version of
the format. The value for the current version of the format is 4
(big-endian 0x00 0x04 or little-endian 0x04 0x00).
This value should change if the format changes in such a way that code
Expand All @@ -149,14 +149,14 @@ implementations as "accuracy of timestamps". Some older pcap file
writers stored non-zero values in this field.

SnapLen (32 bits):
: an unsigned value indicating the maximum number of octets captured
: an unsigned integer indicating the maximum number of octets captured
from each packet. The portion of each packet that exceeds this value
will not be stored in the file. This value MUST NOT be zero; if no
limit was specified, the value SHOULD be a number greater than or equal
to the largest packet length in the file.

LinkType and additional information (32 bits):
: a 32-bit unsigned value that contains the link-layer type of packets
: a 32-bit unsigned integer that contains the link-layer type of packets
in the file and may contain additional information.

The LinkType and additional information field is in the form
Expand Down Expand Up @@ -194,7 +194,7 @@ interpreted by pcap readers; a reader SHOULD treat a non-zero value as
an error.

FCS len (4 bits):
: a 4-bit unsigned value indicating the number of 16-bit (2-octet) words
: a 4-bit unsigned integer indicating the number of 16-bit (2-octet) words
of FCS that are appended to each packet, if the P bit is set; if the P
bit is not set, and the FCS length is not indicated by the link-layer
type value, the FCS length is unknown. The valid values of the FCS len
Expand Down Expand Up @@ -232,21 +232,21 @@ Timestamp (Seconds) and Timestamp (Microseconds or nanoseconds):
: seconds and fraction of a seconds values of a timestamp.
: The seconds value is a 32-bit unsigned integer that represents the
number of seconds that have elapsed since 1970-01-01 00:00:00 UTC, and
the microseconds or nanoseconds value is a 32-bit unsigned value that
the microseconds or nanoseconds value is a 32-bit unsigned integer that
represents the number of microseconds or nanoseconds that have elapsed
since that seconds.
: The Magic Number field in the File Header of a file indicates
whether the values of the Timestamp (Microseconds or nanoseconds) fields
of packets in that file are in units of microseconds or nanoseconds.

Captured Packet Length (32 bits):
: an unsigned value that indicates the number of octets captured from
: an unsigned integer that indicates the number of octets captured from
the packet (i.e., the length of the Packet Data field). It will be the
minimum value among the Original Packet Length and the snapshot length
for the interface (SnapLen, defined in Figure 1).

Original Packet Length (32 bits):
: an unsigned value that indicates the number of octets of packet data
: an unsigned integer that indicates the number of octets of packet data
that would have been provided had the packet not been truncated to the
snapshot length for the interface or to a length limit imposed by the
capture mechanism. If no truncation was done, it will be the same as
Expand Down
46 changes: 23 additions & 23 deletions draft-ietf-opsawg-pcapng.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,14 @@ is shown in {{formatblock}}.

The fields have the following meaning:

* Block Type (32 bits): a unique unsigned value that
* Block Type (32 bits): a unique unsigned integer that
identifies the block. Values whose Most Significant Bit
(MSB) is equal to 1 are reserved for local use. They can be
used to make extensions to the file format to save private
data to the file. The list of currently defined types can
be found in {{section_block_code_registry}}.

* Block Total Length (32 bits): an unsigned value giving
* Block Total Length (32 bits): an unsigned integer giving
the total size of this block, in octets. For instance, the
length of a block that does not have a body is 12 octets: 4
octets for the Block Type, 4 octets for the initial Block
Expand Down Expand Up @@ -419,7 +419,7 @@ fields remain, and to skip all the optional fields at once.
Options are a list of Type - Length - Value fields, each one
containing a single value:

* Option Type (16 bits): an unsigned value that contains
* Option Type (16 bits): an unsigned integer that contains
the code that specifies the type of the current TLV record.
Option types whose Most Significant Bit is equal to one are
reserved for local use; therefore, there is no guarantee
Expand All @@ -429,7 +429,7 @@ containing a single value:
vendor-specific extensions, the Custom Option MUST be used
instead, as defined in {{section_custom_option}}).

* Option Length (16 bits): an unsigned value that contains
* Option Length (16 bits): an unsigned integer that contains
the actual length of the following 'Option Value' field
without the padding octets.

Expand Down Expand Up @@ -743,15 +743,15 @@ The meaning of the fields is:
big-endian machines, and to heuristically identify pcapng
files.

* Major Version (16 bits): an unsigned value, giving the
* Major Version (16 bits): an unsigned integer, giving the
number of the current major version of the format. The
value for the current version of the format is 1.

* Minor Version (16 bits): an unsigned value, giving the
* Minor Version (16 bits): an unsigned integer, giving the
number of the current minor version of the format. The
value for the current version of the format is 0.

* Section Length (64 bits): a signed value specifying the
* Section Length (64 bits): a signed integer specifying the
length in octets of the following section, excluding the
Section Header Block itself. This field can be used to skip
the section, for faster navigation inside large files. If
Expand Down Expand Up @@ -944,15 +944,15 @@ The meaning of the fields is:

* Block Total Length: total size of this block, as described in {{section_block}}.

* LinkType (16 bits): an unsigned value that defines the
* LinkType (16 bits): an unsigned integer that defines the
link layer type of this interface. The list of Standardized
Link Layer Type codes is available in {{I-D.richardson-opsawg-pcaplinktype}}.

* Reserved (16 bits): not used - MUST be filled with 0 by
pcapng file writers, and MUST be ignored by pcapng file
readers.

* SnapLen (32 bits): an unsigned value indicating the
* SnapLen (32 bits): an unsigned integer indicating the
maximum number of octets captured from each packet. The
portion of each packet that exceeds this value will not be
stored in the file. A value of zero indicates no limit.
Expand Down Expand Up @@ -1064,7 +1064,7 @@ Example: '02 34 56 FF FE 78 9A BC'.
{: indent='8'}
if_speed:
: The if_speed
option is a 64-bit unsigned value indicating the interface
option is a 64-bit unsigned integer indicating the interface
speed, in bits per second.
{: vspace='0'}

Expand Down Expand Up @@ -1135,7 +1135,7 @@ Examples: "Windows XP SP2", "openSUSE 10.2".
{: indent='8'}
if_fcslen:
: The if_fcslen
option is an 8-bit unsigned integer value that specifies the
option is an 8-bit unsigned integer that specifies the
length of the Frame Check Sequence (in bits) for this interface.
For link layers whose FCS length can change during time, the
Enhanced Packet Block epb_flags Option can be used in each
Expand All @@ -1148,7 +1148,7 @@ Example: '4'.
{: indent='8'}
if_tsoffset:
: The
if_tsoffset option is a 64-bit signed integer value that
if_tsoffset option is a 64-bit signed integer that
specifies an offset (in seconds) that must be added to the
timestamp of each packet to obtain the absolute timestamp of
a packet. If the option is not present, an offset of 0 is assumed
Expand Down Expand Up @@ -1177,7 +1177,7 @@ Micro Adapter".
{: indent='8'}
if_txspeed:
: The
if_txspeed option is a 64-bit unsigned value
if_txspeed option is a 64-bit unsigned integer
indicating the interface transmit speed in bits per
second.
{: vspace='0'}
Expand All @@ -1189,7 +1189,7 @@ Example: the 64-bit decimal number 1024000 for
{: indent='8'}
if_rxspeed:
: The
if_rxspeed option is a 64-bit unsigned value
if_rxspeed option is a 64-bit unsigned integer
indicating the interface receive speed, in bits per
second.
{: vspace='0'}
Expand Down Expand Up @@ -1279,15 +1279,15 @@ The Enhanced Packet Block has the following fields:

* Block Total Length: total size of this block, as described in {{section_block}}.

* Interface ID (32 bits): an unsigned value that specifies the
* Interface ID (32 bits): an unsigned integer that specifies the
interface on which this packet was received or transmitted;
the correct interface will be the one whose Interface
Description Block (within the current Section of the file) is
identified by the same number (see {{section_idb}})
of this field. The interface ID MUST be valid, which means that an
matching interface description block MUST exist.

* Timestamp (64 bits): two 32-bit unsigned values, representing a single
* Timestamp (64 bits): two 32-bit unsigned integers, representing a single
64-bit unsigned integer, with the first value being the upper 32 bits
of that integer and the second value being the lower 32 bits of that
integer. The 64-bit unsigned integer is a count of units of time.
Expand All @@ -1307,7 +1307,7 @@ The Enhanced Packet Block has the following fields:
Packet Blocks are saved as two 32-bit words that represent
the upper and lower 32 bits of a single 64-bit quantity.

* Captured Packet Length (32 bits): an unsigned value that
* Captured Packet Length (32 bits): an unsigned integer that
indicates the number of octets captured from the packet
(i.e., the length of the Packet Data field). It will be the
minimum value among the Original Packet Length and the
Expand All @@ -1316,7 +1316,7 @@ The Enhanced Packet Block has the following fields:
octets added at the end of the Packet Data field to align the Packet
Data field to a 32-bit boundary.

* Original Packet Length (32 bits): an unsigned value that indicates the
* Original Packet Length (32 bits): an unsigned integer that indicates the
number of octets of packet data that would have been provided had the
packet not been truncated to the snapshot length for the interface or
to a length limit imposed by the capture mechanism. If no truncation
Expand Down Expand Up @@ -1398,7 +1398,7 @@ Examples: '02 EC 1D 87 97', '03 45 6E C2 17 7C 10 1E 3C 2E 99 6E C2 9A 3D
{: indent='8'}
epb_dropcount:
: The
epb_dropcount option is a 64-bit unsigned integer value
epb_dropcount option is a 64-bit unsigned integer
specifying the number of packets lost (by the interface and
the operating system) between this packet and the preceding
one for the same interface or, for the first packet for an
Expand Down Expand Up @@ -1558,7 +1558,7 @@ The Simple Packet Block has the following fields:

* Block Total Length: total size of this block, as described in {{section_block}}.

* Original Packet Length (32 bits): an unsigned value
* Original Packet Length (32 bits): an unsigned integer
indicating the actual length of the packet when it was
transmitted on the network. It can be different from length
of the Packet Data field's length if the packet has been
Expand Down Expand Up @@ -1841,15 +1841,15 @@ The fields have the following meaning:

* Block Total Length: total size of this block, as described in {{section_block}}.

* Interface ID (32 bits): an unsigned value that specifies the
* Interface ID (32 bits): an unsigned integer that specifies the
interface to which these statistics refer; the correct interface
will be the one whose Interface Description Block (within the current
Section of the file) is identified by the same number (see {{section_idb}})
of this field. The interface ID MUST be valid, which means that an
matching interface description block MUST exist.

* Timestamp (64 bits): the time at which the statistics values were
taken; two 32-bit unsigned values, in the same format as defined
taken; two 32-bit unsigned integers, in the same format as defined
for timestamps in the Enhanced Packet Block ({{section_epb}}),
using the 'if_tsresol' and 'if_tsoffset' values from the Interface
Description Block specified by the Interface ID.
Expand Down Expand Up @@ -2602,7 +2602,7 @@ The Packet Block has the following fields:
is reserved for those systems in which this information is not
available.

* Timestamp (64 bits): two 32-bit unsigned values, in the same format
* Timestamp (64 bits): two 32-bit unsigned integers, in the same format
as defined for timestamps in the Enhanced Packet Block ({{section_epb}}),
using the 'if_tsresol' and 'if_tsoffset' values from the Interface
Description Block specified by the Interface ID.
Expand Down
6 changes: 3 additions & 3 deletions draft-richardson-opsawg-pcapng-extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ The fields have the following meaning:

* Block Total Length: total size of this block, as described in {{I-D.tuexen-opsawg-pcapng}}, section "Section Blocks".

* Compression Type (8 bits): an unsigned value that
* Compression Type (8 bits): an unsigned integer that
specifies the compression algorithm. Possible values for
this field are 0 (uncompressed), 1 (Lempel-Ziv), 2 (Gzip),
other?? Probably some kind of dumb and fast compression
Expand Down Expand Up @@ -250,7 +250,7 @@ The fields have the following meaning:

* Block Total Length: total size of this block, as described in {{I-D.tuexen-opsawg-pcapng}}, section "Section Blocks".

* Encryption Type (8 bits): an unsigned value that
* Encryption Type (8 bits): an unsigned integer that
specifies the encryption algorithm. Possible values for
this field are ??? (TODO) NOTE: this block should probably
contain other fields, depending on the encryption algorithm.
Expand Down Expand Up @@ -302,7 +302,7 @@ The fields have the following meaning:

* Block Total Length: total size of this block, as described in {{I-D.tuexen-opsawg-pcapng}}, section "Section Blocks".

* Cell size (16 bits): an unsigned value that indicates the
* Cell size (16 bits): an unsigned integer that indicates the
size of the blocks contained in the data field.

* Fixed Size Data: data of this block.
Expand Down

0 comments on commit 26341d4

Please sign in to comment.