From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Mon, 23 Aug 2021 00:04:55 +0000 (+0200)
Subject: Improve byte-compile-warnings doc string
X-Git-Tag: emacs-28.0.90~1350
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4015fb6e694d2a2593a3db3b65704d783035f46e;p=emacs.git

Improve byte-compile-warnings doc string

* lisp/emacs-lisp/bytecomp.el (byte-compile-warnings): Mention
'byte-compile-docstring-max-column'.
---

diff --git a/etc/NEWS b/etc/NEWS
index 3793bc46265..1866ed0d6d0 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -3736,10 +3736,11 @@ file can affect code in another.  For details, see the manual section
 *** 'byte-recompile-directory' can now compile symlinked ".el" files.
 This is achieved by giving a non-nil FOLLOW-SYMLINKS parameter.
 
+---
 *** The byte-compiler now warns about too wide documentation strings.
 By default, it will warn if a documentation string is wider than the
-largest of 80 characters or 'fill-column'.  This is controlled by the
-new user option 'byte-compile-docstring-max-column'.
+largest of 'byte-compile-docstring-max-column' or 'fill-column'
+characters.
 
 +++
 *** 'byte-compile-file' optional argument LOAD is now obsolete.
@@ -3788,6 +3789,7 @@ presented to users or passed on to other applications.
 ** 'start-process-shell-command' and 'start-file-process-shell-command'
 do not support the old calling conventions any longer.
 
+---
 ** Functions operating on local file names now check that the file names
 don't contain any NUL bytes.  This avoids subtle bugs caused by
 silently using only the part of the file name until the first NUL byte.
diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el
index 7bd642d2b23..145cdbaa6ed 100644
--- a/lisp/emacs-lisp/bytecomp.el
+++ b/lisp/emacs-lisp/bytecomp.el
@@ -322,8 +322,9 @@ Elements of the list may be:
   make-local  calls to make-variable-buffer-local that may be incorrect.
   mapcar      mapcar called for effect.
   constants   let-binding of, or assignment to, constants/nonvariables.
-  docstrings  docstrings that are too wide (longer than 80 characters,
-              or `fill-column', whichever is bigger)
+  docstrings  docstrings that are too wide (longer than
+              `byte-compile-docstring-max-column' or
+              `fill-column' characters, whichever is bigger).
   suspicious  constructs that usually don't do what the coder wanted.
 
 If the list begins with `not', then the remaining elements specify warnings to