diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2022-08-04 08:05:16 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2022-08-04 08:05:25 +0200 |
commit | c17f1a2e89e6980853428b5e08d8a005e99565a6 (patch) | |
tree | ea8856dc3e93a584c7910068e6a4d2a22fa29a01 /doc/lispref | |
parent | caa88cfebec2465ba9bf422d75b741ef3fbfef6e (diff) | |
download | emacs-c17f1a2e89e6980853428b5e08d8a005e99565a6.tar.gz emacs-c17f1a2e89e6980853428b5e08d8a005e99565a6.tar.bz2 emacs-c17f1a2e89e6980853428b5e08d8a005e99565a6.zip |
Adjust documentation for make-docfile
* doc/lispref/loading.texi (Autoload): We're no longer using
make-docfile for loaddefs.el, but we're retaining the format.
Adjust the documentation.
* lisp/loadup.el: Adjust commentary.
Diffstat (limited to 'doc/lispref')
-rw-r--r-- | doc/lispref/loading.texi | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index e8dce433a5b..874200d9f2d 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi @@ -698,14 +698,13 @@ Switch to *doctor* buffer and start giving psychotherapy. @noindent @cindex @code{fn} in function's documentation string -The backslash and newline immediately following the double-quote are a -convention used only in the preloaded uncompiled Lisp files such as -@file{loaddefs.el}; they tell @code{make-docfile} to put the -documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. -See also the commentary in @file{lib-src/make-docfile.c}. @samp{(fn)} -in the usage part of the documentation string is replaced with the -function's name when the various help functions (@pxref{Help -Functions}) display it. +While the @file{loaddefs.el} isn't for editing, we try to keep it +somewhat readable for people. For instance, control characters in +@code{defvar} values are escaped, and we insert a backslash and +newline immediately following the double-quote of the doc string to +keep the line length down. @samp{(fn)} in the usage part of the +documentation string is replaced with the function's name when the +various help functions (@pxref{Help Functions}) display it. If you write a function definition with an unusual macro that is not one of the known and recognized function definition methods, use of an |