From patchwork Sun Jan 29 15:14:08 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= X-Patchwork-Id: 50002 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp1784292wrn; Sun, 29 Jan 2023 07:26:36 -0800 (PST) X-Google-Smtp-Source: AK7set8G6QQjFI9aLSl2j48MNSBHVH1SLKUZ6vPOrxunFqdCdcC8J8gaZPJ3viG9Fi5XrJSiF7dj X-Received: by 2002:a05:6a21:32a1:b0:bc:9494:a7e9 with SMTP id yt33-20020a056a2132a100b000bc9494a7e9mr6407213pzb.22.1675005995806; Sun, 29 Jan 2023 07:26:35 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1675005995; cv=none; d=google.com; s=arc-20160816; b=WN19XI9ULa3SpXbPXcuHa17VlhEmv7Vqh44QY/frRxlvK121QfUghuUD8glPLi/TUK +VrCag1tE1Se08DBtw5jD6edwbKS0yw9/6ih8ROh5n5t0YPvjlSMupW1rBQAXDWaqs9W LcCwCWbsReUC4P/LrDZCLCG3TpCMN/xhS1bl3uL6gb3BFSVNBThD0vT7ApDHK/iTAXJN idX3dQOs7uDw9hAy75AI/zfWK7gU8Z5O09/VhE+UKSrCM+iJMBJJVkcI80P1nHj3isRx /LLNGzCHroUKGXgeGImCeXRCUr7MHJeRmpLb+8geu6o9/BjviaY2CiLsVNpjzjWy1c53 C+pw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:ui-outboundreport:content-transfer-encoding :mime-version:message-id:date:subject:cc:to:from:dkim-signature; bh=jNQDysg2kxJHaI1lidxFdYOjzN3/K2YHukxV9ZnA7dg=; b=V29IiRfWpzGEUPAxPCmw7mL07nGAA7QL8fv4FSEPqZ7rnjf14ScYOSFm5Ne14Cjg4j mKlRL5HHKQlIAAFBQVYKYmRbkAFOG2V4i6g2icyWuLPQcQJwrdgOqhACSISOj8lWFVN/ YWyfu7dEkyiUYW4NSp15HNLNsrA74iMOkhmWusQAeC3hQK6tm1mk7IguNIEMeH23Rzie Dx9eI+St/cEOyANMV3m3XLw5v3sUZoQAFbXe3839JTDnO/dRKPiP0Uo2id2PKP6kvBLZ rZC9wQ9mO1NxYdZ1Zt1CvnbxP/N1kdP26XUETnMUpxhafJ8awH3yX2cx4CYZaemvdv1J tKJQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmx.net header.s=s31663417 header.b="sh/NfCDI"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmx.net Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id x9-20020a63aa49000000b004ad1e82a3e6si9923341pgo.554.2023.01.29.07.26.23; Sun, 29 Jan 2023 07:26:35 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmx.net header.s=s31663417 header.b="sh/NfCDI"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmx.net Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235074AbjA2POs (ORCPT + 99 others); Sun, 29 Jan 2023 10:14:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50938 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229999AbjA2POq (ORCPT ); Sun, 29 Jan 2023 10:14:46 -0500 Received: from mout.gmx.net (mout.gmx.net [212.227.15.19]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 97F381C587; Sun, 29 Jan 2023 07:14:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=s31663417; t=1675005279; bh=Xkk2wNMvCc6Xw7jVSI8Ne2p6gqEgoFqQ1RMVFA8w0Yw=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date; b=sh/NfCDI9eCn9BPMAgRPaidw6AV/PvMbIvmkJlt2FluBL6d08DyfkOYQkGt6jcEeQ 4n7/mHBo3/lQu4cyJwGr/oK9TgL0v4/QMChmsqKF4/48rBI9aaOzVNnMUy2FpGyPwW MIMg5aAzrZn4xkUBLWKXwq8fluA/BDr7bvVuuan2ckdUU2iAR6N6zwiIper6oOgNgL 12YqfKWexdgvMZmuIQHYQcBbNkE/56ic52Wxm4tOMu91BwiF/ryYHFJgZEF1ux+7Ke dDI71NNRZQaCY2hiu61sT3qHPc2wVLKKNe8+CJD4xAMELwPnubIQJdsfYPyFalht/K lm2trhMJYhsTA== X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a Received: from probook ([95.223.44.193]) by mail.gmx.net (mrgmx004 [212.227.17.190]) with ESMTPSA (Nemesis) id 1MuUj2-1oUjmv2KAM-00rUtE; Sun, 29 Jan 2023 16:14:39 +0100 From: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= To: linux-doc@vger.kernel.org Cc: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= , Julia Lawall , Nicolas Palix , Jonathan Corbet , cocci@inria.fr, linux-kernel@vger.kernel.org Subject: [PATCH] Documentation: coccinelle: Escape --options to fix Sphinx output Date: Sun, 29 Jan 2023 16:14:08 +0100 Message-Id: <20230129151408.1525324-1-j.neuschaefer@gmx.net> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Provags-ID: V03:K1:uFBiIphmXEeRlB5va60ud01KyrW18ZmJLRIIc6nBb6esVmlpr6p JZaPv0QxjZtJVFkj7PEPH/zF6GGDNhx3jucFh5vm7g6QGRo909p7YAj0d2sLBOCfs8ggd0u LQIC4lwvlGgRnA/otQNn9JZXQlJwila2brqU/T1Q/a2JP93Sq5AmhPacdgreGg7Fl5yGZ8y eVcL0sKMRsY+jWd6YNFAA== UI-OutboundReport: notjunk:1;M01:P0:h+JDJ6+TucY=;Zm25VJ/b7OpIGuDIL1u9y3y+QEs uKB/BnXtj6JNNyOKpHrtyCHz5a1wPIvrQO2zjjkj+hvCkQss+xjM1ItwXJYB0pXAHQA9RNPzo 8mKD8aMur5PWpIa15J2FKYnXd7jdTjZ2eit+YKXzwx1Z0gREhPZnk3+vsKzEe+IpG7LDUblAM GMEOPNuIDF5QaGkWa8YkVN4d7Ymq4oHaH7p+EJSa5sa8sA19SmGJ5fxDvA12lYb+sWmSJ92Ls 7uQN/QRwi7x0iMm3N4Ryye4f/oa//bMg0J/oxl7wlAdzNk+ufPlK9Jge5rutf7LogEfGxKU0I zF4AVAwMG7um7GchGt2MFDSAb8Ej21otZ6FNNKHsTOpBBGFWACBOidh7TMew3okWmBKQA4IQ/ xwMyUCTAMZPPIK4OC/jl3lO7ewqc7Dw+OHd76ml4A50t0QjOzcJtQs6E5AMrso/KuwJV5/qeG alpwYKCKkixH52/cXihYol4JGgZiKJPyD03rsJH3v4wH3tt5L+zMLO3SqsvGAQzE0UQqgjY/7 jAhRUa/P8g1DZ/uvOGZTJ1yyJDbqMXO2us/YkFDa/QjDazHh286QmlS4/hmyKaNF2CamuJa+s Y2MDFcsjMdFdyPIg9C662sPv/0x5XSBPrmVBjchjpgpavOdDMuGQlP3CQ2OZHsYCE9aYk+j07 pf5Fapzt+ke4gRYSjjwU5m2gM19XhhFornmxGVwh5wLpGewV6BqLlFLCilNJ+fPNsMsg/jF1o 9g/579AHkZ//GtbmstXOXzDOly6pv6rlVTVXNJsif3GJinb1iBJgaZpVTCsV43yC2GiOCRtfD lH9Ykb0HsdrzbEbhXhi+C7Lk1zao3U1aBQyDBJHzxnIER2Gxl1NZnPmdMPpd19KN9Pdy3G1Wr ZEn/E4oHkpuA5VCTfxUD1jtt5ufgPLgssPU+G1T5dcvOtjPKB88QSVSY8M5X5if5P6iQIY3Q1 wxZFz+gjwqUF12iprgPTnpN6GB4= X-Spam-Status: No, score=0.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2,RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1756371087018693652?= X-GMAIL-MSGID: =?utf-8?q?1756371087018693652?= Without such escaping, -- is rendered as – (en dash). Signed-off-by: Jonathan Neuschäfer Acked-by: Julia Lawall Reviewed-by: Bagas Sanjaya --- Documentation/dev-tools/coccinelle.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) -- 2.39.0 diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst index d9976069ed126..535ce126fb4fa 100644 --- a/Documentation/dev-tools/coccinelle.rst +++ b/Documentation/dev-tools/coccinelle.rst @@ -219,7 +219,7 @@ instance:: cat cocci.err You can use SPFLAGS to add debugging flags; for instance you may want to -add both --profile --show-trying to SPFLAGS when debugging. For example +add both ``--profile --show-trying`` to SPFLAGS when debugging. For example you may want to use:: rm -f err.log @@ -248,7 +248,7 @@ variables for .cocciconfig is as follows: - Your current user's home directory is processed first - Your directory from which spatch is called is processed next -- The directory provided with the --dir option is processed last, if used +- The directory provided with the ``--dir`` option is processed last, if used Since coccicheck runs through make, it naturally runs from the kernel proper dir; as such the second rule above would be implied for picking up a @@ -265,8 +265,8 @@ The kernel coccicheck script has:: fi KBUILD_EXTMOD is set when an explicit target with M= is used. For both cases -the spatch --dir argument is used, as such third rule applies when whether M= -is used or not, and when M= is used the target directory can have its own +the spatch ``--dir`` argument is used, as such third rule applies when whether +M= is used or not, and when M= is used the target directory can have its own .cocciconfig file. When M= is not passed as an argument to coccicheck the target directory is the same as the directory from where spatch was called.