IETF DataTracker: draft-mcquistin-augmented-ascii-diagrams
This version removes references to
draft-mcquistin-quic-augmented-diagrams, which have now expired.
The main TCP example and description format are updated to match
This is a minor update to align with the latest version of
Our draft describing a variant of the traditional packet header diagram
that is both human readable and well-enough structured to be parsed
automatically has been updated.
This version adds a section on describing PDUs with Constraints on
Field Sizes, updates the ABNF to match, and updates the examples and
This draft describes a variant of the traditional packet header
diagram that is both human readable and well-enough structured
to be parsed automatically. This revision is a minor update to
the format, incorporating feedback from Wesley Eddy, based on
his use of the format in
the latest revision to the TCP specification.
This draft describes augmented packet diagrams, a machine-readable
format for specifying protocol data units. This version includes
some fixes to the ABNF, adds references to the drafts showing examples
of use, and includes some minor clarifications.
This version of our draft on describing protocol data units updates
the examples for specifying enumerated types is Section 4.8. It also
includes a significant update to correct the ABNF. Thanks to Marc
Petit-Huguenin for reviewing the ABNF.
This version includes some clarifications around the type of fields
with unknown length, and around how to specify the type of PDUs for
parsing and serialisation. It also corrects the ABNF and some samples
of the format.
Add sections on PDUs with constraints on field values; PDUs that extend
sub-structures; storing data for parsing; connecting structures with
functions; specifying enumerated types; and specifying protocol data units.
This version contains a number of editorial fixes and minor
clarifications. It clarifies the rules around uniqueness of
PDU and field names, and more clearly states when field
lengths can be inferred.
This version expands the requirements and further discusses what is
an appropriate degree of expressiveness for a protocol description
language. It clarifies a number of corner cases in the grammar and
specifies how definitions are to be cross-referenced between
documents. A list of known open issues is added.
This document describes a machine-readable format for specifying
the syntax of protocol data units within a protocol specification.
This version tries to make the motivation clearer, is revised to
describe the format by reference to real examples; and adds support
for "PDUs with Non-Contiguous Fields” (e.g., the STUN Message Type
This document describes a machine-readable format for fully specifying
the process by which a protocol can be parsed. This format combines a
consistent ASCII packet diagram format with the use of structured text,
maintaining human readability while enabling support for machine parsing.
This document is itself an example of how this format can be used.
IETF protocol specifications have long relied on packet header diagrams
to illustrate the format of packet headers and other protocol data. This
memo describes a consistent, machine readable, syntax for such diagrams.