summaryrefslogtreecommitdiff
path: root/lisp/subr.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2023-09-15 10:17:30 +0300
committerEli Zaretskii <eliz@gnu.org>2023-09-15 10:17:30 +0300
commit29055412f2d99efbce09447cf88fca567eeafc86 (patch)
tree9adcbe63892f413d879de47c56f21c62c62ffe9c /lisp/subr.el
parent738d8543337ee01eaa889f26da473dc84f652b8a (diff)
downloademacs-29055412f2d99efbce09447cf88fca567eeafc86.tar.gz
emacs-29055412f2d99efbce09447cf88fca567eeafc86.tar.bz2
emacs-29055412f2d99efbce09447cf88fca567eeafc86.zip
; Fix doc string of 'lsh'
* lisp/subr.el (lsh): Doc fix. Suggested by Richard Stallman <rms@gnu.org>.
Diffstat (limited to 'lisp/subr.el')
-rw-r--r--lisp/subr.el6
1 files changed, 4 insertions, 2 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 426e8145cae..d5c461346cb 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -507,8 +507,10 @@ If COUNT is negative, shifting is actually to the right.
In this case, if VALUE is a negative fixnum treat it as unsigned,
i.e., subtract 2 * `most-negative-fixnum' from VALUE before shifting it.
-This function is provided for compatibility. In new code, use `ash'
-instead."
+Most uses of this function turn out to be mistakes. We recommend
+to use `ash' instead, unless COUNT could ever be negative, and
+if, when COUNT is negative, your program really needs the special
+treatment of negative COUNT provided by this function."
(declare (compiler-macro
(lambda (form)
(macroexp-warn-and-return "avoid `lsh'; use `ash' instead"