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.

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

Update BCP 14 language to comply with RFC 8174 #706

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

SamWhited
Copy link
Member

Clarify that normative RFC 2119 language MUST be in all caps.

@SamWhited
Copy link
Member Author

I have no idea if this is an editor, council, or board concern. Thoughts?

@Flowdalic
Copy link
Contributor

I like the idea, but I am a bit worried as this is essentially a non-backwards compatible change: All non-capitalized RFC 2119 keywords in previous XEP texts (if there are any) will lose their semantic. I wonder if we should introduce a appendix-conformance-v2 and just change the template to use this instead, so that previous XEPs are not affected by the change.

@SamWhited
Copy link
Member Author

I really doubt it matters; we can clean it up later if we notice any. As far as I'm aware all recent XEPs are using caps.

@Kev
Copy link
Member

Kev commented Sep 28, 2018

I'm not sure why this would be a good thing - 2119 doesn't require the words to be in caps, why would we benefit from doing so?

@Flowdalic
Copy link
Contributor

I'm not sure why this would be a good thing

I'd say for the same reason RFC 8174 was written.

@Kev
Copy link
Member

Kev commented Oct 1, 2018

Yep, being stupid, ta. I'd have thought Council would be a sensible venue for discussion. I'd have thought we'd need to bump the versions of all the affected XEPs, too, as this affects the reading of them, and probably grepping through to check that we don't have any non-upper-case uses that this would affect.

@SamWhited SamWhited added the Needs Council The affected XEP has the Council as Approving Body and it needs to decide on the change. label Oct 3, 2018
@horazont
Copy link
Contributor

horazont commented Nov 8, 2018

Okay, editors. Since council accepted this, do you have opinions on how we merge this?

  • Simply merge it: Changes the text of all XEPs without revision block.
  • Bump the minor version number of all the XEPs. Possible, I can script that (I already have tools to auto-add revision blocks, so that’s not too bad). Creates a huge diff, a large amount of new revisions (I wouldn’t send emails for that).

Opinions?

@horazont horazont added Needs Version Block The change requires a version block, and this is to be done by Editors at merge time. and removed Needs Council The affected XEP has the Council as Approving Body and it needs to decide on the change. labels Nov 8, 2018
@SamWhited
Copy link
Member Author

Just merge it. It won't change anything in practice and it's not a change to the actual XEPs themselves, just a change to some metadata associated with all XEPs (more or less).

@Kev
Copy link
Member

Kev commented Nov 9, 2018

If revision blocks can be added by script, that is best - our policy is that all XEP changes should have a new revision block, and this is a non-editorial change to many XEPs so would certainly be better with one.

@SamWhited
Copy link
Member Author

I disagree; this isn't a change to the normative XEP text, and is just clarifying the situation as it stands today, its completely editorial. Please just merge this and let's be done with it already.

@SamWhited SamWhited force-pushed the update_bcp_14_language branch from 66ddb17 to a5ec195 Compare April 19, 2020 19:41
@SamWhited
Copy link
Member Author

Rebased. Ping seeking a decision on my last comment. Thanks!

@SamWhited
Copy link
Member Author

Ping again. This was approved quite a while ago.

@SamWhited SamWhited force-pushed the update_bcp_14_language branch from a5ec195 to e6004a9 Compare July 25, 2022 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Version Block The change requires a version block, and this is to be done by Editors at merge time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants