bug#12462: 24.2.50; `C-x C-q' is bound to an obsolete command

bug#12462: 24.2.50; `C-x C-q' is bound to an obsolete command

[Drew Adams]

C-h k C-x C-q
 
 C-x C-q runs the command toggle-read-only, which is an interactive
 compiled Lisp function in `files.el'.
 
 It is bound to C-x C-q.
 
 (toggle-read-only &optional ARG INTERACTIVE)
 
 This function is obsolete since 24.3;
 use `read-only-mode' instead.
 
 Not documented.
 
If the command is obsolete, why is the key bound to it and not to its
replacement?
 
Why does the help say "Not documented"?  Well, because there is no
longer any doc string.  That's a second bug: users now have no doc for
the key.  They can follow the link to the doc for `read-only-mode', but
that is not the command that is invoked.
 
If `C-x C-q' still invokes `toggle-read-only', then `C-h k C-x C-q'
should still provide the doc for `toggle-read-only'.  You removed the
doc string, which explains what `toggle-read-only' does.

In GNU Emacs 24.2.50.1 (i386-mingw-nt5.1.2600)
 of 2012-09-17 on MARVIN
Bzr revision: 110062 cyd@gnu.org-20120917054104-r93rtwkrtva73ewe
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include
 -ID:/devel/emacs/libs/libiconv-1.13.1-1-dev/include
 -ID:/devel/emacs/libs/libxml2-2.7.8/include/libxml2'
 

bug#12462: 24.2.50; `C-x C-q' is bound to an obsolete command

[Drew Adams]

Let me add that the doc string for `read-only-mode' is also not up-to-date, in
the sense that it, in turn, refers back to `toggle-read-only'.

If the latter is really deprecated (let alone obsolete), then the doc should be
updated to reflect this: `read-only-mode' doc should stand alone etc.

bug#12462: 24.2.50; `C-x C-q' is bound to an obsolete command

[Chong Yidong]

"Drew Adams" <drew.adams@oracle.com> writes:

> If the command is obsolete, why is the key bound to it and not to its
> replacement?

Fixed in trunk.

bug#12462: 24.2.50; `C-x C-q' is bound to an obsolete command

[Juri Linkov]

>> If the command is obsolete, why is the key bound to it and not to its
>> replacement?
>
> Fixed in trunk.

I added [remap read-only-mode] to dired.el because this change
broke wdired.  An old [remap toggle-read-only] could still remain for
backward-compatibility.

Also I'm not sure whether `toggle-read-only' should be replaced with
`read-only-mode' in the function `dired-toggle-read-only' and maybe the
name of the function `dired-toggle-read-only' should be changed to
`dired-read-only-mode' in a similar way?

bug#12462: 24.2.50; `C-x C-q' is bound to an obsolete command

[Chong Yidong]

Juri Linkov <juri@jurta.org> writes:

> Also I'm not sure whether `toggle-read-only' should be replaced with
> `read-only-mode' in the function `dired-toggle-read-only'

Yes, this should use (read-only-mode 'toggle).  I changed that and
several other similar use-cases in the trunk.  Thanks.

> and maybe the name of the function `dired-toggle-read-only' should be
> changed to `dired-read-only-mode' in a similar way?

I don't think such a name change would be apropriate, since
dired-read-only-mode is not a separate minor mode.