bug#20135: 25.0.50; Emacs manual typos for key bindings

[Eli Zaretskii]

> Date: Wed, 18 Mar 2015 08:08:47 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> 
> Do we write `<S-up>' or `S-<up>'?  Or do we use both conventions, and if
> so, are they interchangeable (same meaning)?

S-<up> is the right way for the manuals.

> Another question is about whether, aside from special cases (which are
> already called out, AFAIK), function-key names should be written using
> uppercase.  For example, is `<S-RIGHT>" correct, or should it be
> `<S-right>" (or `S-<right>')?

We've been though this before, and AFAIK the manual was fixed to be
consistent at that time.

> In the manual, it seems that the more common syntax is `S-<...>', not
> `<S-...>'.  However, in doc strings the opposite seems to be true (?).

In the doc strings, that's substitution, right?  It's not that these
are written verbatim in the doc string, right?  If so, they are
formatted how the relevant APIs (key-description, I believe) do it.

> 1. Node `View Mode': <S-<SPC>>.  Presumably should be S-<SPC>.

Fixed.

> 2. Node `Org Mode': <S-TAB>.  Should be S-<TAB>, I'm guessing - or
>    possibly S-<tab>, depending on which key is meant.

Fixed.

> 3. Node `Setting Mark': S-<RIGHT>.  Should be S-<right>, I think.
> 
> 4. Node `Indentation Commands': S-<LEFT>, S-<RIGHT>.  Should be
>    S-<left>, S-<right>.  (Also: <LEFT> and <RIGHT> should be <left> and
>    <right>.)
> 
> 5. Node `Setting Mark': S-<RIGHT>.  Should be S-<right>.
> 
> 6. Node `User Input': M-<LEFT> should be M-<left>.
> 
> 7. Node `Moving Point': C-<RIGHT>, M-<RIGHT>, C-<LEFT>, M-<LEFT> should
>    be C-<left>, M-<left>, C-<right>, M-<right>.

No, uppercase is OK here, for consistency with TAB, SPC, etc.  Again,
we've been through this before.

> 8. Node `Minibuffer History': <M-n> should presumably be M-n.

No, it should be `M-n' (with the quotes).  Fixed.

>    (Also, <UP> and <DOWN> should be <up> and <down>.

No, that's OK.

> 9. Node `Basic Indent': <C-j> should be just C-j.

Should be `C-j'; fixed.

> 10. Node `Custom C Indent': <C-M-q> should be just C-M-q.

Again, `C-M-q'; fixed.

> 11. Node `Term Mode: <C-c> should be just C-c.

`C-c'; fixed.

> 12. There is also inconsistency in whether such keys are enclosed in
>    quotes.  Node `Rmail Scrolling' has both notations mixed even in the
>    same sentence (e.g., <SPC>, but `S-<SPC>'):

That's OK: a single key can omit the quotes; a sequence should not.

> 13. I wonder too about the function keys being written with uppercase:
>    <F9> instead of <f9>.  In *Help* buffers (e.g. from `C-h k') they are
>    written using lowercase.

Again, the manuals are consistent: all named keys are uppercased.  If
we want the doc strings to follow suit, the relevant primitives should
be changed to follow suit.

> For example, if you think that <UP> is correct, then search also for
> <up>.  You will find, I think, that what I proposed is used more
> consistently.

I did that in the past, and I don't think we have any inconsistencies
left.  Feel free to point out any you find.

> But there does seem to be a general disconnect between what is shown in
> *Help* by the help commands and what is shown in the manual by Info.
> Help uses <S-foo> whereas the manual uses S-<foo>.
> 
> To me, we should use the same notation for both, and I would vote for
> the manual to fit what help uses.  That is, I would suggest that we
> (consistently) use what `key-description' returns.

I won't object.