Hi all, On Tue, Jun 09, 2020 at 02:16:52PM +0000, Sterne, Jason (Nokia - CA/Ottawa) wrote: > An update on this. We had further discussions on the weekly revision call > just now. Thanks to an interesting new suggestion from Jan L. we're changing > tack on our favorite "extra indicators". > > We're basically down to three very similar options. > > The underscore "_" helps differentiate these from the standard semver "-" or > "+" and will help cause tools that don't understand it to signal that > something unusual needs to be looked at (warning or error). > > Reminder -> this is only in those cases in the draft where the "M" and "m" > were used. Check the draft to see the use cases for these: > https://datatracker.ietf.org/doc/draft-ietf-netmod-yang-semver/?include_text=1 > > ########### > Option J1 > ########### > use the following suffixes: > _non_compatible (instead of the old "M", for an NBC change) > _compatible (instead of the old "m", for a BC change) > > e.g. for NBC: > 1.1.0 -> 1.1.1_non_compatible > e.g. for BC: > 1.1.0 -> 1.1.1_compatible
I like this. It clearly shows what is meant. No special context or knowledge is needed to understand the meaning, or at least to understand that trouble might lie ahead. > ########### > Option J2 > ########### > - same as J1, just one fewer underscore > > e.g. for NBC: > 1.1.0 -> 1.1.1_noncompatible > e.g. for BC: > 1.1.0 -> 1.1.1_compatible I like this a little bit less than J1, because it is a little bit less easy to distinguish between the two words. > ########### > Option J3 > ########### > - use nbc and bc instead of spelling out words > - shorter but not as good for anyone unfamiliar with the spec > > e.g. for NBC: > 1.1.0 -> 1.1.1_nbc > e.g. for BC: > 1.1.0 -> 1.1.1_bc I do not like this as much as J1 and J2, because both _n_on _b_ackwards _c_ompatible and _n_on (or _n_o) _b_reaking _c_hanges could be shortened to NBC. Thus the reader needs to know the specific context where the NBC abbreviation is used. Thanks, Erik _______________________________________________ netmod mailing list [email protected] https://www.ietf.org/mailman/listinfo/netmod
