Documentation/CodingStyle: Use directory-local variables for emacs settings
PATCH v3 1/1 Documentation/CodingStyle: Use directory-local variables for emacs settings
In emacs 23.1 support for directory-local variables was added (see also
https://lists.gnu.org/archive/html/info-gnu-emacs/2009-07/msg00000.html).
Simplify the settings in coding-style.rst by using that feature. Additionally, do not inherit any settings from emacs' linux coding style to minimize dependencies on the version of emacs that is being used.
I have verified with several large and nontrivial kernel source files that the new settings format code according to what checkpatch expects.
---
Changes compared to v2:
- Also updated the Italian and Chinese translations of coding-style.rst.
Changes compared to v1:
- Removed top-level .dir-locals.el file again and updated coding-style.rst instead.
- Restored c-lineup-gcc-asm-reg.
- Restored the humourous paragraph about emacs.
- Left out Italian and Chinese translations.
Documentation/process/coding-style.rst | 57 ++++++++++++------- .../it_IT/process/coding-style.rst | 57 ++++++++++++------- .../translations/zh_CN/coding-style.rst | 57 ++++++++++++------- 3 files changed, 111 insertions(+), 60 deletions(-)
Documentation/process/coding-style.rst +37 -20
@@ -595,26 +595,43 @@ values. To do the latter, you can stick the following in your .emacs file: (* (max steps 1) c-basic-offset))) - (add-hook 'c-mode-common-hook - (lambda () - ;; Add kernel style - (c-add-style - "linux-tabs-only" - '("linux" (c-offsets-alist - (arglist-cont-nonempty - c-lineup-gcc-asm-reg - c-lineup-arglist-tabs-only)))))) - - (add-hook 'c-mode-hook - (lambda () - (let ((filename (buffer-file-name))) - ;; Enable kernel mode for the appropriate files - (when (and filename - (string-match (expand-file-name "~/src/linux-trees") - filename)) - (setq indent-tabs-mode t) - (setq show-trailing-whitespace t) - (c-set-style "linux-tabs-only"))))) + (dir-locals-set-class-variables + 'linux-kernel + '((c-mode . ( + (c-basic-offset . 8) + (c-label-minimum-indentation . 0) + (c-offsets-alist . ( + (arglist-close . c-lineup-arglist-tabs-only) + (arglist-cont-nonempty . + (c-lineup-gcc-asm-reg c-lineup-arglist-tabs-only)) + (arglist-intro . +) + (brace-list-intro . +) + (c . c-lineup-C-comments) + (case-label . 0) + (comment-intro . c-lineup-comment) + (cpp-define-intro . +) + (cpp-macro . -1000) + (cpp-macro-cont . +) + (defun-block-intro . +) + (else-clause . 0) + (func-decl-cont . +) + (inclass . +) + (inher-cont . c-lineup-multi-inher) + (knr-argdecl-intro . 0) + (label . -1000) + (statement . 0) + (statement-block-intro . +) + (statement-case-intro . +) + (statement-cont . +) + (substatement . +) + )) + (indent-tabs-mode . t) + (show-trailing-whitespace . t) + )))) + + (dir-locals-set-directory-class + (expand-file-name "~/src/linux-trees") + 'linux-kernel) This will make emacs go better with the kernel coding style for C files below ``~/src/linux-trees``.
Documentation/translations/it_IT/process/coding-style.rst +37 -20
63 lines not on this page · raw message
Documentation/translations/zh_CN/coding-style.rst +37 -20
63 lines not on this page · raw message
Signature · 1 line
2.20.1.97.g81188d93c3-goog
Quoted 8 lines · Bart Van Assche
In emacs 23.1 support for directory-local variables was added (see also
https://lists.gnu.org/archive/html/info-gnu-emacs/2009-07/msg00000.html).
Simplify the settings incoding-style.rstby using that feature. Additionally, do not inherit any settings from emacs' linux coding style to minimize dependencies on the version of emacs that is being used.I have verified with several large and nontrivial kernel source files that the new settings format code according to what checkpatch expects.
Thanks Bart.
Quoted 9 lines · On Mon, 7 Jan 2019 10:20:19 -0800 Bart Van Assche <[email protected]> wrote:
In emacs 23.1 support for directory-local variables was added (see also
https://lists.gnu.org/archive/html/info-gnu-emacs/2009-07/msg00000.html).
Simplify the settings incoding-style.rstby using that feature. Additionally, do not inherit any settings from emacs' linux coding style to minimize dependencies on the version of emacs that is being used.I have verified with several large and nontrivial kernel source files that the new settings format code according to what checkpatch expects.
Quoted 8 lines
Signed-off-by Bart Van Assche <[email protected]>Cc Matthew Wilcox <[email protected]>Cc Jani Nikula <[email protected]>Cc Alison Chaiken <[email protected]>Cc Joe Perches <[email protected]>Cc Federico Vaga <[email protected]>Cc Geyslan G. Bem <[email protected]>Cc Tiago Natel de Moura <[email protected]>
I've applied this (and I'm off to change my .emacs file). Thanks!
jon