aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBasil L. Contovounesios2018-04-18 18:35:38 +0100
committerNoam Postavsky2018-04-24 20:58:15 -0400
commit343d70b10edbd42ebe49ada3a8ef878b2ee044f0 (patch)
treef9248e93d7a5f7b501d95fa85100b3297be0583b /doc
parent0b432248d8915eaab730d6e3050c43be5622dd87 (diff)
downloademacs-343d70b10edbd42ebe49ada3a8ef878b2ee044f0.tar.gz
emacs-343d70b10edbd42ebe49ada3a8ef878b2ee044f0.zip
Improve kill-related documentation (bug#31209)
* doc/lispref/text.texi (Low-Level Kill Ring): Fix typo under current-kill. Mention interprogram-paste-function under kill-new and kill-append. * lisp/simple.el (save-interprogram-paste-before-kill, kill-new) (kill-append-merge-undo, kill-append): Touch-up docstrings.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/text.texi14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 2db58f31237..6dde4c00f85 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -1142,7 +1142,7 @@ If @var{n} is zero, indicating a request for the latest kill,
1142@code{current-kill} calls the value of 1142@code{current-kill} calls the value of
1143@code{interprogram-paste-function} (documented below) before 1143@code{interprogram-paste-function} (documented below) before
1144consulting the kill ring. If that value is a function and calling it 1144consulting the kill ring. If that value is a function and calling it
1145returns a string or a list of several string, @code{current-kill} 1145returns a string or a list of several strings, @code{current-kill}
1146pushes the strings onto the kill ring and returns the first string. 1146pushes the strings onto the kill ring and returns the first string.
1147It also sets the yanking pointer to point to the kill-ring entry of 1147It also sets the yanking pointer to point to the kill-ring entry of
1148the first string returned by @code{interprogram-paste-function}, 1148the first string returned by @code{interprogram-paste-function},
@@ -1155,8 +1155,10 @@ move the yanking pointer.
1155@defun kill-new string &optional replace 1155@defun kill-new string &optional replace
1156This function pushes the text @var{string} onto the kill ring and 1156This function pushes the text @var{string} onto the kill ring and
1157makes the yanking pointer point to it. It discards the oldest entry 1157makes the yanking pointer point to it. It discards the oldest entry
1158if appropriate. It also invokes the value of 1158if appropriate. It also invokes the values of
1159@code{interprogram-cut-function} (see below). 1159@code{interprogram-paste-function} (subject to
1160the user option @code{save-interprogram-paste-before-kill})
1161and @code{interprogram-cut-function} (see below).
1160 1162
1161If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the 1163If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the
1162first element of the kill ring with @var{string}, rather than pushing 1164first element of the kill ring with @var{string}, rather than pushing
@@ -1168,8 +1170,10 @@ This function appends the text @var{string} to the first entry in the
1168kill ring and makes the yanking pointer point to the combined entry. 1170kill ring and makes the yanking pointer point to the combined entry.
1169Normally @var{string} goes at the end of the entry, but if 1171Normally @var{string} goes at the end of the entry, but if
1170@var{before-p} is non-@code{nil}, it goes at the beginning. This 1172@var{before-p} is non-@code{nil}, it goes at the beginning. This
1171function also invokes the value of @code{interprogram-cut-function} 1173function calls @code{kill-new} as a subroutine, thus causing the
1172(see below). 1174values of @code{interprogram-cut-function} and possibly
1175@code{interprogram-paste-function} (see below) to be invoked by
1176extension.
1173@end defun 1177@end defun
1174 1178
1175@defvar interprogram-paste-function 1179@defvar interprogram-paste-function