diff options
| author | Eli Zaretskii | 2024-05-14 08:51:13 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2024-05-14 08:51:13 +0300 |
| commit | f6d060b39a02da14aa1763bb688cb2e048f0c666 (patch) | |
| tree | 141bca5435b56a367036f4745a4e983e400c704f /doc/lispref | |
| parent | fff245c52931fc829877ae379e48b373c15a1dcb (diff) | |
| download | emacs-f6d060b39a02da14aa1763bb688cb2e048f0c666.tar.gz emacs-f6d060b39a02da14aa1763bb688cb2e048f0c666.zip | |
; Fix documentation of recently-installed changes
* lisp/emacs-lisp/bytecomp.el (compilation-safety): Doc fix.
* etc/NEWS: Fix wording of the 'compilation-safety' entry.
* doc/lispref/functions.texi (Declare Form): Fix cross-reference
and wording.
* doc/lispref/compile.texi (Native-Compilation Variables): Add the
missing @anchor. Fix wording.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/compile.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/functions.texi | 9 |
2 files changed, 15 insertions, 12 deletions
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index f8f1242586e..9f93fb4a981 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -987,21 +987,23 @@ form, @pxref{Declare Form}.) | |||
| 987 | The default value is 2. | 987 | The default value is 2. |
| 988 | @end defopt | 988 | @end defopt |
| 989 | 989 | ||
| 990 | @anchor{compilation-safety} | ||
| 990 | @defopt compilation-safety | 991 | @defopt compilation-safety |
| 991 | This variable specifies the safetyness level used for the code emitted | 992 | This variable specifies the safety level to be used for the emitted |
| 992 | native code. The value of compilation-safety should be a number between | 993 | native code. The value should be a number, either 0 or 1 with the |
| 993 | zero and one with the following meaning: | 994 | following meanings: |
| 994 | 995 | ||
| 995 | @table @asis | 996 | @table @asis |
| 996 | @item 0 | 997 | @item 0 |
| 997 | Emitted code can misbehave or crash Emacs if function declarations are | 998 | Emitted code can misbehave (up to even crashing Emacs) if a function's |
| 998 | not correct and the function is native compiled. | 999 | declaration does not describe correctly what the function does or how it |
| 1000 | is called, and the function is natively compiled. | ||
| 999 | @item 1 | 1001 | @item 1 |
| 1000 | Emitted code is generated in a safe matter even if function are | 1002 | Emitted code must be generated in a safe manner even if functions are |
| 1001 | miss-declared." | 1003 | mis-declared. |
| 1002 | @end table | 1004 | @end table |
| 1003 | 1005 | ||
| 1004 | This can be controlled at function granularity as well by using the | 1006 | This can also be controlled at a function granularity, by using the |
| 1005 | @code{safety} @code{declare} form, @pxref{Declare Form}. | 1007 | @code{safety} @code{declare} form, @pxref{Declare Form}. |
| 1006 | @end defopt | 1008 | @end defopt |
| 1007 | 1009 | ||
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index 9d4ecd8da25..deca99960c7 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi | |||
| @@ -2761,10 +2761,11 @@ argument of type @var{string} and return one of the symbols | |||
| 2761 | For description of additional types, see @ref{Lisp Data Types}). | 2761 | For description of additional types, see @ref{Lisp Data Types}). |
| 2762 | 2762 | ||
| 2763 | Declaring a function with an incorrect type produces undefined behavior | 2763 | Declaring a function with an incorrect type produces undefined behavior |
| 2764 | and could lead to unexpected results or might even crash Emacs when code | 2764 | and could lead to unexpected results or might even crash Emacs when |
| 2765 | is native-compiled and loaded if compiled with @ref{compilation-safety} | 2765 | natively-compiled code is loaded, if it was compiled with |
| 2766 | 0. Note also that when redefining (or advising) a type declared | 2766 | @code{compilation-safety} level of zero (@pxref{compilation-safety}). |
| 2767 | function the replacement should respect the original signature to avoid | 2767 | Note also that when redefining (or advising) a type-declared function, |
| 2768 | the replacement should respect the original signature to avoid such | ||
| 2768 | undefined behavior. | 2769 | undefined behavior. |
| 2769 | 2770 | ||
| 2770 | @item no-font-lock-keyword | 2771 | @item no-font-lock-keyword |