mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-26 23:31:55 -08:00
Code Issues Projects Releases Wiki Activity

Improve byte-compile-warnings doc string

Browse source 
* lisp/emacs-lisp/bytecomp.el (byte-compile-warnings): Mention
'byte-compile-docstring-max-column'.
This commit is contained in:
Lars Ingebrigtsen 2021-08-23 02:04:55 +02:00
parent 5d32630f79
commit 4015fb6e69
2 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
etc/NEWS
View file

@ -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. *** 'byte-recompile-directory' can now compile symlinked ".el" files.
This is achieved by giving a non-nil FOLLOW-SYMLINKS parameter. This is achieved by giving a non-nil FOLLOW-SYMLINKS parameter.
---
*** The byte-compiler now warns about too wide documentation strings. *** The byte-compiler now warns about too wide documentation strings.
By default, it will warn if a documentation string is wider than the 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 largest of 'byte-compile-docstring-max-column' or 'fill-column'
new user option 'byte-compile-docstring-max-column'. characters.
+++ +++
*** 'byte-compile-file' optional argument LOAD is now obsolete. *** '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' ** 'start-process-shell-command' and 'start-file-process-shell-command'
do not support the old calling conventions any longer. do not support the old calling conventions any longer.
---
** Functions operating on local file names now check that the file names ** Functions operating on local file names now check that the file names
don't contain any NUL bytes. This avoids subtle bugs caused by 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. silently using only the part of the file name until the first NUL byte.

5
lisp/emacs-lisp/bytecomp.el
View file

@ -322,8 +322,9 @@ Elements of the list may be:
make-local calls to make-variable-buffer-local that may be incorrect. make-local calls to make-variable-buffer-local that may be incorrect.
mapcar mapcar called for effect. mapcar mapcar called for effect.
constants let-binding of, or assignment to, constants/nonvariables. constants let-binding of, or assignment to, constants/nonvariables.
docstrings docstrings that are too wide (longer than 80 characters, docstrings docstrings that are too wide (longer than
or `fill-column', whichever is bigger) `byte-compile-docstring-max-column' or
`fill-column' characters, whichever is bigger).
suspicious constructs that usually don't do what the coder wanted. suspicious constructs that usually don't do what the coder wanted.
If the list begins with `not', then the remaining elements specify warnings to If the list begins with `not', then the remaining elements specify warnings to