Skip to content

Commit

Permalink
Fix #434: Remove obsolete TODO section in README
Browse files Browse the repository at this point in the history
Update the link to the auto-generated versions of the P4Runtime
specification on the P4.org web site.

Update the section "P4 Language Version Applicability" to version
1.2.4 of the P4_16 language specification, but list 3 known exceptions
of features that have not been explicitly addressed yet.
  • Loading branch information
jafingerhut committed Aug 13, 2023
1 parent 1e771c4 commit ae28b0e
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 13 deletions.
13 changes: 11 additions & 2 deletions docs/v1/P4Runtime-Spec.mdk
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,17 @@ format and available at
P4Runtime is designed to be implemented in conjunction with the P4~16~ language
version or later. P4~14~ programs should be translated into P4~16~ to be made
compatible with P4Runtime. This version of P4Runtime utilizes features which are
not in P4~16~ 1.0, but were introduced in P4~16~ 1.1.0 [@P4Revisions110]. For
this version of P4Runtime, we recommend using P4~16~ 1.2.1 [@P4Spec].
not in P4~16~ 1.0, but were introduced in P4~16~ 1.2.4 [@P4Revisions124]. For
this version of P4Runtime, we recommend using P4~16~ 1.2.4 [@P4Revisions124].

This version of the P4Runtime specification does not yet explicitly
address compatibility with the following P4~16~ language features
introduced in version 1.2.2 of the language specification [@P4Revisions122]:

* Added support for generic structures.
* Added support for additional enumeration types.
* Added support for 0-width bitstrings and varbits.


## In Scope

Expand Down
13 changes: 2 additions & 11 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ specification document.

The markup version uses Madoko (https://www.madoko.net) to produce
HTML and PDF versions of the documentation. Pre-built versions of the
documentation are available at **[TODO]**
documentation are available on the [P4.org specifications
page](https://p4.org/specs).


Files:
Expand Down Expand Up @@ -63,13 +64,3 @@ Note that to build the PDF you need a functional TeX version installed.
You need to install miktex [http://miktex.org/], madoko
[https://www.madoko.net/] and node.js [https://nodejs.org/en/]. To
build you can invoke the make.bat script.


# TODO
## Formating Fixups TODO

## Content TODO
Following are major content items which are missing or incomplete:
* Section 17. P4Runtime Versioning
* Section 18. Extending P4Runtime for non-PSA architectures
* Section 19. Lifetime of a session
10 changes: 10 additions & 0 deletions docs/v1/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ @ONLINE { P4Revisions110
url = "https://p4.org/p4-spec/docs/P4-16-v1.2.1.html#sec-summary-of-changes-made-in-version-110"
}

@ONLINE { P4Revisions122,
title = "Summary of changes made in $P4_{16}$ version 1.2.2",
url = "https://p4.org/p4-spec/docs/P4-16-v1.2.4.html#sec-summary-of-changes-made-in-version-122-released-may-17-2021"
}

@ONLINE { P4Revisions124,
title = "Summary of changes made in $P4_{16}$ version 1.2.4",
url = "https://p4.org/p4-spec/docs/P4-16-v1.2.4.html#sec-summary-of-changes-made-in-version-124"
}

@ONLINE { P4Spec,
title = "$P4_{16}$ 1.2.1 specification",
url = "https://p4.org/p4-spec/docs/P4-16-v1.2.1.html"
Expand Down

0 comments on commit ae28b0e

Please sign in to comment.