summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/comp.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2024-03-20 16:08:15 +0200
committerEli Zaretskii <eliz@gnu.org>2024-03-20 16:08:15 +0200
commitae9d8eedfdd6030a082010ac933b4aa4ddc05749 (patch)
tree505d99eff60f1a514705318d8f408a8b2f8fceef /lisp/emacs-lisp/comp.el
parente2fec514fd22e61c2a4e9343056aa744e93203a1 (diff)
downloademacs-ae9d8eedfdd6030a082010ac933b4aa4ddc05749.tar.gz
emacs-ae9d8eedfdd6030a082010ac933b4aa4ddc05749.tar.bz2
emacs-ae9d8eedfdd6030a082010ac933b4aa4ddc05749.zip
; Minor copyedits of last change.
Diffstat (limited to 'lisp/emacs-lisp/comp.el')
-rw-r--r--lisp/emacs-lisp/comp.el25
1 files changed, 13 insertions, 12 deletions
diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
index 7e8d4e15e0a..1df1e3b3ddb 100644
--- a/lisp/emacs-lisp/comp.el
+++ b/lisp/emacs-lisp/comp.el
@@ -3010,24 +3010,25 @@ These are substituted with a normal `set' op."
;;; Sanitizer pass specific code.
-;; This pass aims to verify compile time value type predictions during
-;; execution.
+;; This pass aims to verify compile-time value-type predictions during
+;; execution of the code.
;; The sanitizer pass injects a call to 'helper_sanitizer_assert' before
-;; each conditional branch. 'helper_sanitizer_assert' will verify that
+;; each conditional branch. 'helper_sanitizer_assert' will verify that
;; the variable tested by the conditional branch is of the predicted
-;; value type and signal an error otherwise.
+;; value type, or signal an error otherwise.
;;; Example:
-;; Assuming we want to compile 'test.el' and test function `foo' defined
-;; into it.
-;; Native compile 'test.el' instrumenting it for sanitizer usage.
-;; (let ((comp-sanitizer-emit t))
-;; (load (native-compile "test.el")))
+;; Assume we want to compile 'test.el' and test the function `foo'
+;; defined in it. Then:
-;; Run `foo' with the sanitizer active.
-;; (let ((comp-sanitizer-active t))
-;; (foo))
+;; - Native-compile 'test.el' instrumenting it for sanitizer usage:
+;; (let ((comp-sanitizer-emit t))
+;; (load (native-compile "test.el")))
+
+;; - Run `foo' with the sanitizer active:
+;; (let ((comp-sanitizer-active t))
+;; (foo))
(defvar comp-sanitizer-emit nil
"Gates the sanitizer pass.