bug#19773: 23.2; kill-rectangle documentation

bug#19773: 23.2; kill-rectangle documentation

[vincent douzal]

Hello,

The documentation string for kill-rectangle erroneously speaks about the
kill ring.  Rectangles of text are not copied to the kill ring, but in
the variable kill-rectangle, which besides is not a ring.

This can be puzzle new users.

Regards

Vincent Douzal


In GNU Emacs 23.2.1 (i486-pc-linux-gnu, GTK+ Version 2.20.1)
 of 2013-01-09 on murphy, modified by Debian

Windowing system distributor `The X.Org Foundation', version 11.0.10707000
configured using `configure  '--build' 'i486-linux-gnu' '--build' 'i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var/lib' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs23:/etc/emacs:/usr/local/share/emacs/23.2/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.2/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/23.2/leim' '--with-x=yes' '--with-x-toolkit=gtk' '--with-toolkit-scroll-bars' 'build_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2' 'LDFLAGS=-g' 'CPPFLAGS=''

bug#19773: 23.2; kill-rectangle documentation

[npostavs]

[-- Attachment #1: Type: text/plain, Size: 460 bytes --]

tags 19773 patch
quit

vincent douzal <vincent.douzal@teledetection.fr> writes:

> Hello,
>
> The documentation string for kill-rectangle erroneously speaks about the
> kill ring.  Rectangles of text are not copied to the kill ring, but in
> the variable kill-rectangle, which besides is not a ring.

Hmm yeah, looks like copy-pasto.  Should we mention the variable name
directly in the docstring (as in patch below) or is it better to just
say it's "saved"?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch --]
[-- Type: text/x-diff, Size: 1333 bytes --]

From e2455dd16032f21884b39169a70386801a27392a Mon Sep 17 00:00:00 2001
From: Noam Postavsky <npostavs@gmail.com>
Date: Sun, 3 Jul 2016 21:40:26 -0400
Subject: [PATCH v1] kill-rectangle should mention kill-rectangle

* lisp/rect.el (kill-rectangle): Mention `killed-rectangle' in docstring
and warning message, rather than kill ring (Bug#19773).
---
 lisp/rect.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/rect.el b/lisp/rect.el
index 43621d9..8fedce2 100644
--- a/lisp/rect.el
+++ b/lisp/rect.el
@@ -284,7 +284,7 @@ kill-rectangle
 deleted.
 
 If the buffer is read-only, Emacs will beep and refrain from deleting
-the rectangle, but put it in the kill ring anyway.  This means that
+the rectangle, but put it in `killed-rectangle' anyway.  This means that
 you can use this command to copy text from a read-only buffer.
 \(If the variable `kill-read-only-ok' is non-nil, then this won't
 even beep.)"
@@ -295,7 +295,7 @@ kill-rectangle
      (setq deactivate-mark t)
      (setq killed-rectangle (extract-rectangle start end))
      (if kill-read-only-ok
-	 (progn (message "Read only text copied to kill ring") nil)
+	 (progn (message "Read only text copied to `killed-rectangle'") nil)
        (barf-if-buffer-read-only)
        (signal 'text-read-only (list (current-buffer)))))))
 
-- 
2.8.0

bug#19773: 23.2; kill-rectangle documentation

[npostavs]

tags 19773 fixed
close 19773 25.1
quit

Pushed as 219b39f5