xeps icon indicating copy to clipboard operation
xeps copied to clipboard

Update BCP 14 language to comply with RFC 8174

Open SamWhited opened this issue 7 years ago • 12 comments

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

SamWhited avatar Sep 24 '18 21:09 SamWhited

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

SamWhited avatar Sep 24 '18 21:09 SamWhited

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.

Flowdalic avatar Sep 24 '18 21:09 Flowdalic

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.

SamWhited avatar Sep 24 '18 21:09 SamWhited

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?

Kev avatar Sep 28 '18 08:09 Kev

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

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

Flowdalic avatar Sep 28 '18 09:09 Flowdalic

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.

Kev avatar Oct 01 '18 09:10 Kev

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 avatar Nov 08 '18 19:11 horazont

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).

SamWhited avatar Nov 08 '18 19:11 SamWhited

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.

Kev avatar Nov 09 '18 08:11 Kev

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 avatar Nov 09 '18 15:11 SamWhited

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

SamWhited avatar Apr 19 '20 19:04 SamWhited

Ping again. This was approved quite a while ago.

SamWhited avatar Jul 25 '22 16:07 SamWhited