diff options
| -rw-r--r-- | doc/lispref/tips.texi | 16 | ||||
| -rw-r--r-- | etc/NEWS | 22 |
2 files changed, 27 insertions, 11 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index d9cbf473306..ffce920bf4e 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -14,11 +14,17 @@ it gives advice on making effective use of the features described in the previous chapters, and describes conventions Emacs Lisp programmers should follow. +@findex checkdoc +@findex checkdoc-current-buffer +@findex checkdoc-file You can automatically check some of the conventions described below by running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. It cannot check all of the conventions, and not all the warnings it gives necessarily correspond to problems, but it is worth examining them -all. +all. Alternatively, use the command @kbd{M-x checkdoc-current-buffer RET} +to check the conventions in the current buffer, or @code{checkdoc-file} +when you want to check a file in batch mode, e.g., with a command run by +@kbd{@w{M-x compile RET}}. @menu * Coding Conventions:: Conventions for clean and robust programs. @@ -1007,8 +1013,14 @@ of multiple files, we recommend not writing the version in every file, but only the main one. @item Keywords +@vindex checkdoc-package-keywords-flag +@findex checkdoc-package-keywords This line lists keywords for the @code{finder-by-keyword} help command. -Please use that command to see a list of the meaningful keywords. +Please use that command to see a list of the meaningful keywords. The +command @kbd{M-x checkdoc-package-keywords RET} will find and display +any keywords that are not in @code{finder-known-keywords}. If you set +the variable @code{checkdoc-package-keywords-flag} non-@code{nil}, +checkdoc commands will include the keyword verification in its checks. This field is how people will find your package when they're looking for things by topic. To separate the keywords, you can use spaces, @@ -135,15 +135,6 @@ frames. Works for functions, variables, faces, etc. It is bound to `C-h o' by default. -** New command `checkdoc-package-keywords' checks if the -current package keywords are recognized. Set the new option -`checkdoc-package-keywords-flag' to non-nil to make -`checkdoc-current-buffer' call this function automatically. - -** New function `checkdoc-file' checks for style errors. -It's meant for use together with `compile': -emacs -batch --eval "(checkdoc-file \"subr.el\")" - ** New command `comment-line' bound to `C-x C-;'. ** New function `custom-prompt-customize-unsaved-options' checks for @@ -360,6 +351,19 @@ standards. * Changes in Specialized Modes and Packages in Emacs 25.1 +** Checkdoc + ++++ +*** New command `checkdoc-package-keywords' checks if the +current package keywords are recognized. Set the new option +`checkdoc-package-keywords-flag' to non-nil to make +`checkdoc-current-buffer' call this function automatically. + ++++ +*** New function `checkdoc-file' checks for style errors. +It's meant for use together with `compile': +emacs -batch --eval "(checkdoc-file \"subr.el\")" + ** New function `bookmark-set-no-overwrite' bound to C-x r M. It raises an error if a bookmark of that name already exists, unlike `bookmark-set' which silently updates an existing bookmark. |