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

Rename /OPER command /oper everywhere #191

Closed
wants to merge 1 commit into from
Closed

Conversation

Perdu
Copy link

@Perdu Perdu commented Sep 12, 2023

Weechat is in the process of making its identifiers case-sensitive (see https://specs.weechat.org/specs/2023-001-case-sensitive-identifiers.html#changes). As a result, /OPER is no longer a valid weechat command.

This patch is an example patch to address this issue, replacing all /OPER references to /oper.

I don't know if this affects other IRC clients and if there is a standard favoring /OPER or /oper.

It's an example patch, you may want to replace the message with e.g. "use /oper or /OPER in older weechat versions".

@jelmer jelmer self-requested a review September 12, 2023 16:11
Copy link
Member

@jelmer jelmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, not super convinced about this. I think if we change the casing of /OPER we should change the casing of other commands (/QUIT, /PART, /JOIN, etc) as well for consistency.

Even if most clients support case-sensitive commands, I think (?) it's more common to write them in uppercase. The protocol level commands in the RFC are also in uppercase. See the documentation for OPER in irssi here: https://irssi.org/documentation/help/oper/

@jelmer
Copy link
Member

jelmer commented Sep 12, 2023

Why are they doing this? It's not like they'll (reasonably) be able to reuse "/OPER" for different purposes than "/oper" so it seems like dropping support for the uppercase version will just make things more confusing for their users.

@Perdu
Copy link
Author

Perdu commented Sep 14, 2023

Well, as you can see, they won't change that.

What do you think of either:

  • changing to /oper as proposed in this PR (but it's not ideal, as pointed earlier)
  • changing to a formulation such as "/OPER (or /oper on some clients)" or "/OPER (/oper on weechat)"?

@jelmer
Copy link
Member

jelmer commented Sep 14, 2023

I'm open to the idea of just changing /OPER to /oper, but we should make sure we don't just change /OPER but other commands in the documentation (/PART, /MSG, /JOIN, /QUIT, etc) as well. At the moment we use a mix of uppercase and lowercase in our docs.
(changing to lowercase is going to fix weechat, but who knows when the next client comes along that only accepts uppercase commands; that's merely theoretical at this point so let's not worry about it)

That said, I don't want to add "(or /oper on weechat)" to the docs - we don't want to have to document special cases for every client that doesn't follow the common conventions. weechat are the ones intentionally breaking the status quo here. That's their prerogative, but their users are going to have to deal with the fact that lots of other places on the web reference uppercase commands anyway.

@dequis
Copy link
Member

dequis commented Sep 14, 2023

Sounds like they made bad decisions! I don't think that's our problem!

@dgw
Copy link

dgw commented Sep 14, 2023

Yeah, the <letter> pseudo-BNF token is defined (on page 9 of RFC 1459) as either upper- or lowercase. The protocol explicitly doesn't care about the casing of commands; OPER, oper, oPer, Oper, OpEr, and every other combination of casings is valid.

It's silly to force client commands—especially those that are named for their protocol equivalents—to be case-sensitive, but at the very least a single client's silliness shouldn't affect how BitlBee documents stuff for everyone else.

@Perdu
Copy link
Author

Perdu commented Sep 15, 2023

So, there are more opinions towards not changing anything? It's not worth crafting a better patch, then?

@Perdu
Copy link
Author

Perdu commented Oct 2, 2023

Closing, then

@Perdu Perdu closed this Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants