search

p4lang / p4runtime

Specification documents for the P4Runtime control-plane API
Apache License 2.0
144 stars 88 forks source link

[breaking change] use common data structure for all annotations #287

Closed smolkaj closed 4 years ago

smolkaj commented 4 years ago

This is non-backward-compatible solution to issue #285. To be included in 2.0.

antoninbas commented 4 years ago

@smolkaj this should probably be an issue at this stage and not a PR against master, which we cannot merge for a while.

It is possible that time has come for us to create a development branch for P4Runtime v2.0, but even then it makes sense to have a corresponding issue that we can use for tracking.

jafingerhut commented 4 years ago

It is entirely up to the working group how they want to handle this in the Github repo files, but an alternative to creating a branch is to have separate directories for v1 and v2 of the P4Runtime API spec, and initially populate v2 files with copies of the latest v1 files.

There are disadvantages to such an approach, but a potential advantage is to make it easier to continue to make small corrections/clarifications to the v1 files as time goes on, and easily keep them "in the file system" for operations like auto-generating HTML/PDF from both v1 and v2 without doing git checkout operations.

smolkaj commented 4 years ago

I created #288 to track this.

smolkaj commented 4 years ago

I will close this PR until it becomes relevant again.

smolkaj commented 4 years ago

Just opening this temporarily to incorporate updates pointed out by @chrispsommers .