Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Are whitespace changes allow between two module instances with the same version (or revision)? #8

Closed
rgwilton opened this issue Mar 7, 2019 · 7 comments
Closed

Are whitespace changes allow between two module instances with the same version (or revision)? #8

rgwilton opened this issue Mar 7, 2019 · 7 comments
Assignees
@Reshad-Rahman
Labels
updated-mod-rev-handling Issues related to yang-module-versioning (updated module revision handling draft) yang-semver-soln Issues that apply to yang-semver (yang semver solution draft)

Comments

@rgwilton
Copy link
Collaborator

rgwilton commented Mar 7, 2019

For example, if I reformat the module from 69 characters to 120 characters then is that an editorial change? Noting that the whitespace within a description statement has changed.

What if I keep description statements exactly the same and only change insignificant whitespace, .e.g. perhaps changing 4 char indentation to 2 char indentation?
@rgwilton rgwilton added the yang-semver-soln Issues that apply to yang-semver (yang semver solution draft) label Mar 7, 2019
@BalazsLengyel
Copy link
Collaborator

Such whitespace changes are the most frequently (andincorrectly, annoyingly) found changes to our modules.
IMHO if you only change whitespace (excluding whitespace in singe or double quotes for description, reference, string default values etc.) that should be considered either

  • no-change - preferrred
  • editorial

@rgwilton
Copy link
Collaborator Author

Currently the checksum in the YANG packages draft will take into account whitespace. This doesn't directly affect the version of a module, but should at least be considered.

@jsterne jsterne added updated-mod-rev-handling Issues related to yang-module-versioning (updated module revision handling draft) and removed yang-semver-soln Issues that apply to yang-semver (yang semver solution draft) labels Jun 22, 2020
@Reshad-Rahman
Copy link
Collaborator

PATCH update for whitespace change

Reshad-Rahman added a commit that referenced this issue Jun 30, 2020
@Reshad-Rahman
Updating as per June 30th meeting
6185ebd 
#8
@Reshad-Rahman
Copy link
Collaborator

Draft currently says editorial change.

@Reshad-Rahman Reshad-Rahman mentioned this issue Jul 21, 2020
Closed
@Reshad-Rahman Reshad-Rahman added the yang-semver-soln Issues that apply to yang-semver (yang semver solution draft) label Jul 22, 2020
xorrkaz pushed a commit that referenced this issue Feb 19, 2021
@jclarke-csco
Add some more text for issues #8 and #45.
1582ccb 
Mention whitespace changes as an example editorial change and mandate
that IETF modules must use YANG semver (some text borrowed from IANA
text).

Suggested by:	Jason Sterne
@Reshad-Rahman
Copy link
Collaborator

Text from latest rev to be sent to WG.

@rgwilton
Copy link
Collaborator Author

rgwilton commented May 4, 2021 •
edited

In Reshad's dev branch, but not pushed.

Issue can be closed once latest branch has been pushed.

@Reshad-Rahman Reshad-Rahman self-assigned this May 4, 2021
@Reshad-Rahman
Copy link
Collaborator

Update has been pushed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Reshad-Rahman Reshad-Rahman

Labels
updated-mod-rev-handling Issues related to yang-module-versioning (updated module revision handling draft) yang-semver-soln Issues that apply to yang-semver (yang semver solution draft)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Reshad-Rahman @rgwilton @BalazsLengyel @jsterne