p4runtime icon indicating copy to clipboard operation
p4runtime copied to clipboard

New protobuf entities should have a comment of the form "Added in x.y.z"

Open smolkaj opened this issue 1 year ago • 2 comments

Context: https://github.com/p4lang/p4runtime/pull/432#discussion_r1212101247

I propose that going forward, when adding new fields/messages/services to our P4Runtime protobuf schemas, we always include comments such as

// Added in 1.4.0.

This allows developers to reason about forward/backward compatibility of various sever/client combinations when the server and client may be using different versions of the protobuf schemas.

@jafingerhut @chrispsommers WDYT?

smolkaj avatar Jul 18 '23 18:07 smolkaj

Seems like a good ideato me!

chrispsommers avatar Jul 18 '23 18:07 chrispsommers

Agreed

jafingerhut avatar Jul 19 '23 02:07 jafingerhut