From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham autolearn_force=no version=3.4.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 8D0677D04D for ; Fri, 4 Jan 2019 21:09:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726117AbfADVJM (ORCPT ); Fri, 4 Jan 2019 16:09:12 -0500 Received: from com-out001.mailprotect.be ([83.217.72.83]:42239 "EHLO com-out001.mailprotect.be" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726021AbfADVJM (ORCPT ); Fri, 4 Jan 2019 16:09:12 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=mailprotect.be; s=mail; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: reply-to:sender:bcc; bh=ZeiSuTPGIW3gMI8Nmru7CRTWkTYw023zkODbTF1P2Lg=; b=pK3LK K2Y85lgkZLosfSKmEq9hhJG8gqquJtf+85SBFt71fqDWFCFdBlGdZcng4YGBFKiFLlWCyO296f8Gp ndnySVZYaeMHoTyggb0XM6fex0ofWrsFw+Xk2uYN+3WxIO5kT+XrG+d88V+rH6UuRvql2x9YXkmib H3Te7W951j5CDAOtE0DmdJM9eh5SjrTZXPd2ZrvsgFo1uC7jAlo17f8+9TcckN5sJ8EIvHSWIy10i n1EwdmolgtEedhtLyvmGjUp/vsuGTxbYcIsvpTKCEfsCrBx/dCHeUbUb9ztMHPqRAcQurbfsywcIo AgxIbvezcdKKgqA3aPbyKltcqLI4Q==; Received: from smtp-auth.mailprotect.be ([178.208.39.155]) by com-mpt-out001.mailprotect.be with esmtp (Exim 4.89) (envelope-from ) id 1gfWi6-000G0K-QN; Fri, 04 Jan 2019 22:08:56 +0100 Received: from desktop-bart.svl.corp.google.com (unknown [104.133.8.89]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp-auth.mailprotect.be (Postfix) with ESMTPSA id 862FDC067D; Fri, 4 Jan 2019 22:08:47 +0100 (CET) From: Bart Van Assche To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, Bart Van Assche , Matthew Wilcox , "Geyslan G . Bem" , Tiago Natel de Moura , Alison Chaiken , Joe Perches , Federico Vaga , Li Yang , Alison Chaiken , Zhang Le Subject: [PATCH] Documentation/CodingStyle: Move emacs settings into .dir-locals.el Date: Fri, 4 Jan 2019 13:08:34 -0800 Message-Id: <20190104210834.89231-2-bvanassche@acm.org> X-Mailer: git-send-email 2.20.1.97.g81188d93c3-goog In-Reply-To: <20190104210834.89231-1-bvanassche@acm.org> References: <20190104210834.89231-1-bvanassche@acm.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Originating-IP: 178.208.39.155 X-SpamExperts-Domain: mailprotect.be X-SpamExperts-Username: 178.208.39.128/27 Authentication-Results: mailprotect.be; auth=pass smtp.auth=178.208.39.128/27@mailprotect.be X-SpamExperts-Outgoing-Class: ham X-SpamExperts-Outgoing-Evidence: Combined (0.25) X-Recommended-Action: accept X-Filter-ID: EX5BVjFpneJeBchSMxfU5jvtBatn2yZ9KcuI3vBTnZ1602E9L7XzfQH6nu9C/Fh9KJzpNe6xgvOx q3u0UDjvO1tLifGj39bI0bcPyaJsYTa43A6BbHuOu26FlWSYmB0jprpEIVWhNaoEAGLLS3GB4P6V WgQtuS/IXgP0xwejNzDQAUvi9XHeIiNnhtyCKUw0I2HAwFBqpIgRJo+X1GtjfpmUPCfWgo4cXgSA zG3g07U8OEo76qVJVxuINHb26YLjukWZD1h798R57Z0syWRHu/XDYrS2HTh9sGUju1oFdhSfOuv4 tDkLKddi2+yr+P82lF2H77pKwl7tov8Jpga6BpIYCECTk2bZrfYcEzjEBBwfnFvzyq1Y/FTDb0Ci oSRzOAyiweHXfTdkiLcwsLz1lFZ1i94uMFPUPY6tmo9FmJV7n69tYkHRfqDLoEJhE5kNYS9O4jFx Zrl+bjwVnZTptmDCePLiKScA2/UNz/8edkVPSMJ9MLLz5O0VTjBPC8X1kwyAHgtXZgjWI4w9UWhK NaazVG6Qh+nNDRNzDzlqofsgtCujFgev91YjBSdZpRheIydO31EWZcEjp3WC93Y0+FMN4aojEWZM bRqnTqS6r14e9oqbmtqiyBNrbXmKxcLjgDQZGBbIYJN6x80get8SxZGv/9u6nu2iDHaxZQ+TEzxE DBffVZVjmVaNbG4ZJG7FcSlVtPPHGHv8PWszlgyWH3V+03Iv9XY2kVc2CNtUsmbVve57xU1K8Pp0 Q+1H8lmBvCrJPmnnTHzVkpybMK7ZTSeZpgz36b8B8R7Rt4+KE3lz8Ne0ck6P4ivKdWmRJx+gj+nE CkhyOrL2OLfNMuUZWEhbqq/s+t91+6HZXo/Ygf5+7/XN71cbpIVuo2oBFcabaIfVaCHpEB6cFH6W JxE4ZlwQTqBlTnLEhBHAshyllV197+xt+PuCetUIzBhUOc1cLaE7z81lDDg5rlq9wPIw0JA/Knfb 5oyEHudCOEqdkmynCUnvHpGmt8vyd4rzSs9R61MsuSALS3f9taWqwfLY1osEMysPur9wmiDBurOy 6iTzJ65e1tKiqW/qzgdG1/iRHQoQao/7JDM01gj7K3G5/+gBaJOdm74WWjwlTtHyH1jfLzSnqCMR b0U3AJM238bsZuM7jUXIESohoO51xWmU8S4yZzYJlmOWBJN8I44lPrMWjRrE10Hv65x2y1nZ7R5y oOSfd+B5QHPKTEhD9L9nNRmok11u89pTKgJ27pjsIdJqwsH34g4DK+ocmbpsbYddXGI265x4XnxR AgwG2DhnLYalL4LoE8AgSzw+KJWjcRuMBLPd+zBmOO/Edag/JxUiV4VsSfOC6XxosKsW39t0M49U bMAcDcESrX7c8a6326k= X-Report-Abuse-To: spam@com-mpt-mgt001.mailprotect.be Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org For new kernel developers who use emacs it is tedious to follow the instructions in Documentation/process/coding-style.rst for configuring emacs. Make it easier for emacs users by moving these settings into the top-level .dir-locals.el file. Emacs supports directory-local variables since version 23.1, released in 2009. See also https://lists.gnu.org/archive/html/info-gnu-emacs/2009-07/msg00000.html The settings in .dir-locals.el are not identical to those in Documentation/process/coding-style.rst. The most important difference is that "(arglist-cont-nonempty c-lineup-gcc-asm-reg c-lineup-arglist-tabs-only)" (which is not a valid alist) has been changed into "(arglist-cont-nonempty . c-lineup-arglist)". I have verified with several large and nontrivial kernel source files that the settings in .dir-locals.el format code according to what checkpatch expects. The Italian and Chinese translations of the modified paragraphs have been generated by Google Translate. Signed-off-by: Bart Van Assche Cc: Geyslan G. Bem Cc: Tiago Natel de Moura Cc: Alison Chaiken Cc: Joe Perches Cc: Federico Vaga Cc: Zhang Le Cc: Li Yang --- .dir-locals.el | 41 +++++++++++++++ Documentation/process/coding-style.rst | 49 ++---------------- .../it_IT/process/coding-style.rst | 50 ++----------------- .../translations/zh_CN/coding-style.rst | 43 +--------------- 4 files changed, 53 insertions(+), 130 deletions(-) create mode 100644 .dir-locals.el diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 000000000000..8cf857a00772 --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,41 @@ +;; Emacs settings for Linux kernel C code. + +( + (c-mode . ( + (c-basic-offset . 8) + (c-cleanup-list . (brace-else-brace)) + (c-hanging-braces-alist . ( + (arglist-cont-nonempty) + (block-close . c-snug-do-while) + (brace-entry-open) + (brace-list-open) + (substatement-open after) + )) + (c-label-minimum-indentation . 0) + (c-offsets-alist . ( + (arglist-cont-nonempty . c-lineup-arglist) + (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 . 0) + (statement . 0) + (statement-block-intro . +) + (statement-case-intro . +) + (statement-cont . +) + (substatement . +) + )) + (indent-tabs-mode . t) + ) + ) +) diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst index 277c113376a6..e12b845d6766 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst @@ -571,50 +571,11 @@ item, explaining its use. 9) You've made a mess of it --------------------------- -That's OK, we all do. You've probably been told by your long-time Unix -user helper that ``GNU emacs`` automatically formats the C sources for -you, and you've noticed that yes, it does do that, but the defaults it -uses are less than desirable (in fact, they are worse than random -typing - an infinite number of monkeys typing into GNU emacs would never -make a good program). - -So, you can either get rid of GNU emacs, or change it to use saner -values. To do the latter, you can stick the following in your .emacs file: - -.. code-block:: none - - (defun c-lineup-arglist-tabs-only (ignored) - "Line up argument lists by tabs, not spaces" - (let* ((anchor (c-langelem-pos c-syntactic-element)) - (column (c-langelem-2nd-pos c-syntactic-element)) - (offset (- (1+ column) anchor)) - (steps (floor offset c-basic-offset))) - (* (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"))))) - -This will make emacs go better with the kernel coding style for C -files below ``~/src/linux-trees``. +``GNU emacs`` automatically formats the C sources for you. However, +the defaults it uses are less than desirable. Use a version of emacs +that support directory local variables such that it automatically +picks up the settings from .dir-locals.el in the kernel top level +directory. But even if you fail in getting emacs to do sane formatting, not everything is lost: use ``indent``. diff --git a/Documentation/translations/it_IT/process/coding-style.rst b/Documentation/translations/it_IT/process/coding-style.rst index b707bdbe178c..05a86c69bd5d 100644 --- a/Documentation/translations/it_IT/process/coding-style.rst +++ b/Documentation/translations/it_IT/process/coding-style.rst @@ -578,51 +578,11 @@ commento per spiegarne l'uso. 9) Avete fatto un pasticcio --------------------------- -Va bene, li facciamo tutti. Probabilmente vi è stato detto dal vostro -aiutante Unix di fiducia che ``GNU emacs`` formatta automaticamente il -codice C per conto vostro, e avete notato che sì, in effetti lo fa, ma che -i modi predefiniti non sono proprio allettanti (infatti, sono peggio che -premere tasti a caso - un numero infinito di scimmie che scrivono in -GNU emacs non faranno mai un buon programma). - -Quindi, potete sbarazzarvi di GNU emacs, o riconfigurarlo con valori più -sensati. Per fare quest'ultima cosa, potete appiccicare il codice che -segue nel vostro file .emacs: - -.. code-block:: none - - (defun c-lineup-arglist-tabs-only (ignored) - "Line up argument lists by tabs, not spaces" - (let* ((anchor (c-langelem-pos c-syntactic-element)) - (column (c-langelem-2nd-pos c-syntactic-element)) - (offset (- (1+ column) anchor)) - (steps (floor offset c-basic-offset))) - (* (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"))))) - -Questo farà funzionare meglio emacs con lo stile del kernel per i file che -si trovano nella cartella ``~/src/linux-trees``. +`` GNU emacs`` formatta automaticamente le sorgenti C per te. Tuttavia, +le impostazioni predefinite che utilizza sono meno desiderabili. +Utilizzare una versione di emacs che supporti le variabili locali della +directory in modo tale che raccolga automaticamente le impostazioni da +.dir-locals.el nella directory di livello superiore del kernel. Ma anche se doveste fallire nell'ottenere una formattazione sensata in emacs non tutto è perduto: usate ``indent``. diff --git a/Documentation/translations/zh_CN/coding-style.rst b/Documentation/translations/zh_CN/coding-style.rst index 1466aa64b8b4..32a72a9c110a 100644 --- a/Documentation/translations/zh_CN/coding-style.rst +++ b/Documentation/translations/zh_CN/coding-style.rst @@ -516,47 +516,8 @@ Documentation/doc-guide/ 和 scripts/kernel-doc 以获得详细信息。 9) 你已经把事情弄糟了 ------------------------------ -这没什么，我们都是这样。可能你的使用了很长时间 Unix 的朋友已经告诉你 -``GNU emacs`` 能自动帮你格式化 C 源代码，而且你也注意到了，确实是这样，不过它 -所使用的默认值和我们想要的相去甚远 (实际上，甚至比随机打的还要差——无数个猴子 -在 GNU emacs 里打字永远不会创造出一个好程序) (译注：Infinite Monkey Theorem) - -所以你要么放弃 GNU emacs，要么改变它让它使用更合理的设定。要采用后一个方案， -你可以把下面这段粘贴到你的 .emacs 文件里。 - -.. code-block:: none - - (defun c-lineup-arglist-tabs-only (ignored) - "Line up argument lists by tabs, not spaces" - (let* ((anchor (c-langelem-pos c-syntactic-element)) - (column (c-langelem-2nd-pos c-syntactic-element)) - (offset (- (1+ column) anchor)) - (steps (floor offset c-basic-offset))) - (* (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"))))) - -这会让 emacs 在 ``~/src/linux-trees`` 下的 C 源文件获得更好的内核代码风格。 +``GNU emacs``會自動為您設置C源代碼。但是，它使用的默認值不太理想。 +使用支持目錄本地變量的emacs版本，以便它自動從內核頂級目錄中的.dir-locals.el中獲取設置。 不过就算你尝试让 emacs 正确的格式化代码失败了，也并不意味着你失去了一切：还可 以用 ``indent`` 。 -- 2.20.1.415.g653613c723-goog