From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 15 Sep 2023 07:17:30 +0000 (+0300)
Subject: ; Fix doc string of 'lsh'
X-Git-Tag: emacs-29.1.90~92
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=29055412f2d99efbce09447cf88fca567eeafc86;p=emacs.git

; Fix doc string of 'lsh'

* lisp/subr.el (lsh): Doc fix.  Suggested by Richard Stallman
<rms@gnu.org>.
---

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"