| Server IP : 217.160.0.212 / Your IP : 216.73.217.5 Web Server : Apache System : Linux www 6.18.52-i1-ampere #1203 SMP Mon Sep 14 18:29:59 CEST 2026 aarch64 User : sws1073854427 ( 1073854427) PHP Version : 8.4.23 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /usr/share/emacs/28.2/lisp/emacs-lisp/ |
Upload File : |
;ELC
;;; Compiled
;;; in Emacs version 28.2
;;; with all optimizations.
(byte-code "\300\301!\210\300\302!\210\300\303!\210\300\304!\210\300\305!\210\300\306!\210\300\307!\210\310\311\312\313\314\315\316\317\320\321& \210\322\323\324\325\326DD\327\330\331\320\332&\210\322\333\324\325\334DD\335\330\336%\210\322\337\324\325\340DD\341\330\342%\210\322\343\324\325\344DD\345\330\342%\210\322\346\324\325\347DD\350\330\342%\210\322\351\324\325\352DD\353\330\342%\210\322\354\324\325\355DD\356\330\357%\207" [require bytecomp cl-lib help-mode thingatpt lisp-mode dired lisp-mnt custom-declare-group checkdoc nil "Support for doc string checking in Emacs Lisp." :prefix "checkdoc" :group lisp :version "20.3" custom-declare-variable checkdoc-minor-mode-string funcall function #[0 "\300\207" [" CDoc"] 1 #1=""] "String to display in mode line when Checkdoc mode is enabled; nil for none." :type (choice string (const :tag "None" nil)) "23.1" checkdoc-autofix-flag #[0 "\300\207" [semiautomatic] 1 #1#] "Non-nil means attempt auto-fixing of doc strings.\nIf this value is the symbol `query', then the user is queried before\nany change is made. If the value is `automatic', then all changes are\nmade without asking unless the change is very complex. If the value\nis `semiautomatic' or any other value, then simple fixes are made\nwithout asking, and complex changes are made by asking the user first.\nThe value `never' is the same as nil, never ask or change anything." (choice (const automatic) (const query) (const never) (other :tag "semiautomatic" semiautomatic)) checkdoc-bouncy-flag #[0 "\300\207" [t] 1 #1#] "Non-nil means to \"bounce\" to auto-fix locations.\nSetting this to nil will silently make fixes that require no user\ninteraction. See `checkdoc-autofix-flag' for auto-fixing details." boolean checkdoc-force-docstrings-flag #[0 "\300\207" [t] 1 #1#] "Non-nil means that all checkable definitions should have documentation.\nStyle guide dictates that interactive functions MUST have documentation,\nand that it's good but not required practice to make non user visible items\nhave doc strings." checkdoc-force-history-flag #[0 "\300\207" [nil] 1 #1#] "Non-nil means that files should have a History section or ChangeLog file.\nThis helps document the evolution of, and recent changes to, the package." checkdoc-permit-comma-termination-flag #[0 "\300\207" [nil] 1 #1#] "Non-nil means the first line of a docstring may end with a comma.\nOrdinarily, a full sentence is required. This may be misleading when\nthere is a substantial caveat to the one-line description -- the comma\nshould be used when the first part could stand alone as a sentence, but\nit indicates that a modifying clause follows." checkdoc-spellcheck-documentation-flag #[0 "\300\207" [nil] 1 #1#] "Non-nil means run Ispell on text based on value.\nThis is automatically set to nil if Ispell does not exist on your\nsystem. Possible values are:\n\n nil - Don't spell-check during basic style checks.\n defun - Spell-check when style checking a single defun.\n buffer - Spell-check when style checking the whole buffer.\n interactive - Spell-check during any interactive check.\n t - Always spell-check.\n\nThere is a list of Lisp-specific words which checkdoc will\ninstall into Ispell on the fly, but only if Ispell is not already\nrunning. Use `ispell-kill-ispell' to make checkdoc restart it\nwith these words enabled." (choice (const nil) (const defun) (const buffer) (const interactive) (const t))] 10)
#@72 List of words that are correct when spell-checking Lisp documentation.
(defvar checkdoc-ispell-lisp-words '("alist" "emacs" "etags" "keymap" "paren" "regexp" "sexp" "xemacs") (#$ . 3542))
(byte-code "\300\301\302\303\304DD\305\306\307\310\311&\210\300\312\302\303\313DD\314\310\315\306\316&\210\300\317\302\303\320DD\321\310\322\306\316&\210\323\324\325\326#\210\327\211\203U \211@\324N\203N \325N\204N \330\325\324N#\210A\266\202\2024 \210\331\324\325\332#\207" [custom-declare-variable checkdoc-max-keyref-before-warn funcall function #[0 "\300\207" [nil] 1 #1=""] "If non-nil, number of \\\\=[command-to-keystroke] tokens allowed in a doc string.\nAny more than this and a warning is generated suggesting that the construct\n\\\\={mapvar} be used instead. If the value is nil, never warn.\n\nIt used to not be practical to use `\\\\=[...]' very many times,\nbecause display of the documentation string would become slow.\nThis is not an issue on modern machines, unless you have\nthousands of substitutions." :type (choice (const nil) integer) :version "28.1" checkdoc-arguments-in-order-flag #[0 "\300\207" [nil] 1 #1#] "Non-nil means warn if arguments appear out of order.\nSetting this to nil will mean only checking that all the arguments\nappear in the proper form in the documentation, not that they are in\nthe same order as they appear in the argument list. No mention is\nmade in the style guide relating to order." "26.1" boolean checkdoc-package-keywords-flag #[0 "\300\207" [nil] 1 #1#] "Non-nil means warn if this file's package keywords are not recognized.\nCurrently, all recognized keywords must be on `finder-known-keywords'." "25.1" defvaralias checkdoc-style-hooks checkdoc-style-functions nil (saved-value saved-variable-comment) put make-obsolete-variable "24.3"] 8)
#@358 Hook run after the standard style check is completed.
All functions must return nil or a string representing the error found.
Useful for adding new user implemented commands.
Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
location of end of the documentation string.
(defvar checkdoc-style-functions nil (#$ . 5350))
(byte-code "\300\301\302\303#\210\304\211\203( \211@\301N\203! \302N\204! \305\302\301N#\210A\266\202\202 \210\306\301\302\307#\207" [defvaralias checkdoc-comment-style-hooks checkdoc-comment-style-functions nil (saved-value saved-variable-comment) put make-obsolete-variable "24.3"] 7)
#@196 Hook run after the standard comment style check is completed.
Must return nil if no errors are found, or a string describing the
problem discovered. This is useful for adding additional checks.
(defvar checkdoc-comment-style-functions nil (#$ . 6057))
#@33 Name of warning message buffer.
(defvar checkdoc-diagnostic-buffer "*Style Warnings*" (#$ . 6316))
(byte-code "\300\301\302\303\304DD\305\306\307%\207" [custom-declare-variable checkdoc-verb-check-experimental-flag funcall function #[0 "\300\207" [t] 1 ""] "Non-nil means to attempt to check the voice of the doc string.\nThis check keys off some words which are commonly misused. See the\nvariable `checkdoc-common-verbs-wrong-voice' if you wish to add your own." :type boolean] 6)
#@157 Non-nil means generate warnings in a buffer for browsing.
Do not set this by hand, use a function like `checkdoc-current-buffer'
with a universal argument.
(defvar checkdoc-generate-compile-warnings-flag nil (#$ . 6807))
(byte-code "\300\301\302\303\304DD\305\306\307\310\311&\210\300\312\302\303\313DD\314\306\315\310\311&\207" [custom-declare-variable checkdoc-symbol-words funcall function #[0 "\300\207" [("beginning-of-buffer" "beginning-of-line" "byte-code" "byte-compile" "command-line" "end-of-buffer" "end-of-line" "major-mode" "point-max" "point-min" "syntax-table" "top-level" "user-error" "version-control" "window-system")] 1 #1=""] "A list of symbol names (strings) which also happen to make good words.\nThese words are ignored when unquoted symbols are searched for.\nThis should be set in an Emacs Lisp file's local variables." :type (repeat (string :tag "Word")) :version "28.1" checkdoc-column-zero-backslash-before-paren #[0 "\300\207" [t] 1 #1#] "Non-nil means to warn if there is no '\\' before '(' in column zero.\nThis backslash is no longer needed on Emacs 27.1 or later.\n\nSee Info node `(elisp) Documentation Tips' for background." boolean] 8)
#@305 Non-nil means warn if arguments are missing from docstring.
This variable is intended for use on Emacs itself, where the
large number of libraries means it is impractical to fix all
of these warnings en masse. In almost any other case, setting
this to anything but t is likely to be counter-productive.
(defvar checkdoc--argument-missing-flag t (#$ . 7988))
#@289 Non-nil means ask to disambiguate Lisp symbol.
This variable is intended for use on Emacs itself, where the
large number of libraries means it is impractical to fix all
of these warnings masse. In almost any other case, setting
this to anything but t is likely to be counter-productive.
(defvar checkdoc--disambiguate-symbol-flag t (#$ . 8354))
#@303 Non-nil means warn if interactive function has no docstring.
This variable is intended for use on Emacs itself, where the
large number of libraries means it is impractical to fix all
of these warnings masse. In almost any other case, setting
this to anything but t is likely to be counter-productive.
(defvar checkdoc--interactive-docstring-flag t (#$ . 8707))
#@51 Return t when OBJ is a list of strings.
(fn OBJ)
(defalias 'checkdoc-list-of-strings-p #[257 "\211<\205\f \300\301\302\">?\207" [nil mapcar stringp] 5 (#$ . 9075)])
#@62 List of words (not capitalized) which should be capitalized.
(defvar checkdoc-proper-noun-list '("emacs" "lisp" "dired") (#$ . 9248))
#@64 Regular expression derived from `checkdoc-proper-noun-regexp'.
(defvar checkdoc-proper-noun-regexp (byte-code "\301\302\303\"\304Q\207" [checkdoc-proper-noun-list "\\_<" regexp-opt t "\\(\\_>\\|[.!?][ \n\"]\\)"] 4) (#$ . 9388))
#@65 Regular expression derived from `checkdoc-common-verbs-regexp'.
(defvar checkdoc-common-verbs-regexp nil (#$ . 9624))
#@296 Alist of common words in the wrong voice and what should be used instead.
Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
and experimental check. Do not modify this list without setting
the value of `checkdoc-common-verbs-regexp' to nil which cause it to
be re-created.
(defvar checkdoc-common-verbs-wrong-voice '(("adds" . "add") ("allows" . "allow") ("appends" . "append") ("applies" . "apply") ("arranges" . "arrange") ("brings" . "bring") ("calls" . "call") ("catches" . "catch") ("changes" . "change") ("checks" . "check") ("contains" . "contain") ("converts" . "convert") ("creates" . "create") ("defines" . "define") ("destroys" . "destroy") ("determines" . "determine") ("disables" . "disable") ("echoes" . "echo") ("executes" . "execute") ("extends" . "extend") ("evals" . "evaluate") ("evaluates" . "evaluate") ("finds" . "find") ("forces" . "force") ("gathers" . "gather") ("generates" . "generate") ("goes" . "go") ("guesses" . "guess") ("highlights" . "highlight") ("holds" . "hold") ("ignores" . "ignore") ("indents" . "indent") ("initializes" . "initialize") ("inserts" . "insert") ("installs" . "install") ("investigates" . "investigate") ("keeps" . "keep") ("kills" . "kill") ("leaves" . "leave") ("lets" . "let") ("loads" . "load") ("looks" . "look") ("makes" . "make") ("marks" . "mark") ("moves" . "move") ("notifies" . "notify") ("offers" . "offer") ("parses" . "parse") ("performs" . "perform") ("prepares" . "prepare") ("prepends" . "prepend") ("prompts" . "prompt") ("reads" . "read") ("raises" . "raise") ("removes" . "remove") ("replaces" . "replace") ("resets" . "reset") ("restores" . "restore") ("returns" . "return") ("runs" . "run") ("saves" . "save") ("says" . "say") ("searches" . "search") ("selects" . "select") ("sets" . "set") ("sex" . "s*x") ("shows" . "show") ("signifies" . "signify") ("sorts" . "sort") ("starts" . "start") ("steps" . "step") ("stores" . "store") ("switches" . "switch") ("tells" . "tell") ("tests" . "test") ("toggles" . "toggle") ("tries" . "try") ("turns" . "turn") ("undoes" . "undo") ("unloads" . "unload") ("unmarks" . "unmark") ("updates" . "update") ("uses" . "use") ("yanks" . "yank")) (#$ . 9749))
#@52 Syntax table used by checkdoc in document strings.
(defvar checkdoc-syntax-table (byte-code "\301!\302\303\304#\210\207" [emacs-lisp-mode-syntax-table make-syntax-table modify-syntax-entry 45 "w"] 5) (#$ . 11946))
#@40 Name of buffer used for Checkdoc Help.
(defconst checkdoc--help-buffer "*Checkdoc Help*" (#$ . 12168))
#@173 Interactively check the entire buffer for style errors.
The current status of the check will be displayed in a buffer which
the users will view as each check is completed.
(defalias 'checkdoc #[0 "\303\304\211\211F\305>@ \203 \306=\203 \307\202 \310\311!\210\n\204* \312\2024 \313 \2033 \314\2024 \315\240\210A\211\303\240\266\311!\210\316\310\317\"\262A\211\203V \320\321G\"\202W \315\240\266AA\211\303\240\266\311!\210AA\211\322\310\317\"\211\262\203| \320\321G\"\202} \315\240\266\323\233\211\303\240\266\311!\210\323\233\211\3241\234 \325\310\317\"0\202\240 \210\202\247 \203\247 \314\202\250 \315\240\266\311!*\207" [checkdoc-spellcheck-documentation-flag checkdoc-autofix-flag buffer-file-name "Checking..." "-" (buffer interactive t) never query nil checkdoc-display-status-buffer "Not checked" checkdoc-file-comments-engine "Errors" "Ok" checkdoc-interactive t format "%d Errors" checkdoc-message-interactive 3 (error) checkdoc-rogue-spaces] 9 (#$ . 12278) [nil (emacs-lisp-mode)]])
#@207 Display and update the status buffer for the current checkdoc mode.
CHECK is a list of four strings stating the current status of each
test; the nth string describes the status of the nth test.
(fn CHECK)
(defalias 'checkdoc-display-status-buffer #[257 "\306 r\307\310!q\210p\311 \210\306\211\312\211\312\313 \210\314\300!\210+\211\315\316\317@\320A@\321\322\n8\323\324\f8\257\"\210\325!\210)\266)\326\327\310!!\210\330\306!\210\331\332!\207" [temp-buffer-setup-hook default-directory buffer-read-only buffer-file-name buffer-undo-list inhibit-modification-hooks nil get-buffer-create "*Checkdoc Status*" kill-all-local-variables t erase-buffer run-hooks mapc princ "Buffer comments and tags: " "\nDocumentation style: " "\nMessage/Query text style: " 2 "\nUnwanted Spaces: " 3 internal-temp-output-buffer-show shrink-window-if-larger-than-buffer get-buffer-window message sit-for 0 inhibit-read-only standard-output] 15 (#$ . 13309)])
#@475 Interactively check the current buffer for doc string errors.
Prefix argument START-HERE will start the checking from the current
point, otherwise the check starts at the beginning of the current
buffer. Allows navigation forward and backwards through document
errors. Does not check for comment or space warnings.
Optional argument SHOWSTATUS indicates that we should update the
checkdoc status window instead of the usual behavior.
(fn &optional START-HERE SHOWSTATUS)
(defalias 'checkdoc-interactive #[512 "\301>@\302\303#\304!\210)\207" [checkdoc-spellcheck-documentation-flag (interactive t) checkdoc-interactive-loop checkdoc-next-error checkdoc-interactive-ispell-loop] 6 (#$ . 14290) ["P" (emacs-lisp-mode)]])
#@479 Interactively check the current buffer for message string errors.
Prefix argument START-HERE will start the checking from the current
point, otherwise the check starts at the beginning of the current
buffer. Allows navigation forward and backwards through document
errors. Does not check for comment or space warnings.
Optional argument SHOWSTATUS indicates that we should update the
checkdoc status window instead of the usual behavior.
(fn &optional START-HERE SHOWSTATUS)
(defalias 'checkdoc-message-interactive #[512 "\301>@\302\303#\304!\210)\207" [checkdoc-spellcheck-documentation-flag (interactive t) checkdoc-interactive-loop checkdoc-next-message-error checkdoc-message-interactive-ispell-loop] 6 (#$ . 15023) ["P" (emacs-lisp-mode)]])
#@628 Interactively loop over all errors that can be found by a given method.
If START-HERE is nil, searching starts at the beginning of the current
buffer, otherwise searching starts at START-HERE. SHOWSTATUS
expresses the verbosity of the search, and whether ending the search
will auto-exit this function.
FINDFUNC is a symbol representing a function that will position the
cursor, and return error message text to present to the user. It is
assumed that the cursor will stop just before a major sexp, which will
be highlighted to present the user with feedback as to the offending
style.
(fn START-HERE SHOWSTATUS FINDFUNC)
(defalias 'checkdoc-interactive-loop #[771 "`\204 eb\210\306>@\307!C\307C\307\211\310 \311\312\"\216@\204$ \307\262\313 \210\203_@Ab\210@@;\203E \212\314`\315\316!\210`\")\202S \314\317@@!\320@@!\"\240\210\311\321\"\216\322\242\323\324#\210\325\326!\210g\327U\203\237 \330\212\315\316!\210`)\331 \"\204\237 \332`\212\315\316!\210`)\"\211\333 V\203\222 \334\316!\266\202\242 \334\333 Z\335\245!\266\202\242 \334 \210\336\337\340@@!\341@@!\203\267 \342\202\270 \343#\210\212\317@@!b\210\330 \204\316 \334\333 \335Z!\210\344 \262)\250\204\333 \345\262\346\267\202\365\347\350\307\"\210\202[\351\242!\210\307\240\210@Ab\210\352\307\353!\210 \352=?\262\211\204\336\354!\210\325\335!\210\202A\262)\266\313 \210\307!\211\2032\211B\262\210\202[\204B\336\355!\210\325\335!\266\202[\336\356!\210\325\335!\266\202[\307!\211\204|\203e\262\307\262\210\202[\204p\336\355!\210\202t\336\356!\210\325\335!\266\202[\211B\262\210\202[G\316U\204\234A\262@Ab\210\313 \210\202[\336\357!\210\325\335!\210\202[\360\340@@!!\210\351\242!\210A\262\313 \210\307!\211\204\337\203\323\262\307\262\210\202[\336\355!\210\325\335!\266\202[\211B\262\210\202[\262\307\262`\262\202[\361\n!\203\362\361\n!!\210\363\n!\210\202[r\364\n!q\210p\365 \210\307\211\353\211@\353AB\366 \210\367\370!\210+\211CrCq\210\371\341@@!\203@\342\202A\372\373\374\375\376\377\261\210)\201D !\210)\266\201E \361\n!!\210)\202'