From patchwork Tue Nov 22 18:49:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 24504 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp2383311wrr; Tue, 22 Nov 2022 10:50:47 -0800 (PST) X-Google-Smtp-Source: AA0mqf6xyjYlCPF0JGrnB05pB6jRD+C+AW201Qf/wPiX6v99p5fdR/cWjTYjMQ4Aicz4ORf+LkBN X-Received: by 2002:a63:4c4d:0:b0:46f:8c3a:8b2b with SMTP id m13-20020a634c4d000000b0046f8c3a8b2bmr4980952pgl.477.1669143046810; Tue, 22 Nov 2022 10:50:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669143046; cv=none; d=google.com; s=arc-20160816; b=00wT1p2dqqFh60nsM239JS9Kg+7B0kuD0hrqo+mbUBVCfrOSKzNrvX0kSAcOPs9hOT aBP82Y2fDvwhplwVUlwoPNvwL5Z+RlQuYgD8jY18Id9vATdaFCHha7U/4XAUXgBmUhEv 7YstrkRU4ELLw2Leay3Ylv4PkEScIVR8LLmgHgkPOvIRRTQ/3OOFzDkHacd8S1ZqDr0o nMtOhaKYMx5ePA3o7aPnt9Rqj731IzaOEnAlvBZVn+i9yNYbsRIv7/hrR6khTNge51xe XIZpHC9b8ecRln+JkgRFBf9uIlUWlu1VBRj2hrvQGMgefAHhMIkjonDI0i/95GAC/1Bi vIzw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=xKyX3vVodLJd24qW93YmnRz/lx6JTsZ1cMhhyQ3baFo=; b=at+GEoR4iQNA52072fkvCgaZkAtUgkXzBY+HJAkBPABL65W6CpUh2hLEKGSips9MbX ijXWMyPL0Qf5WslAXFfbg+e2HI0WeOD6VTzYZUDRF+T0aUl0BOfdD5xkb4rjn+rNx3pe aqMKD5P+qDgYccUjGwdkT8o4lDvwMdXYBGqhoqG/ud7wy3ASB0kuX/NC9iF8kvgpX700 UpBm8hM6iOVbCdwHHX+EPp8qpdbfDNPBT1EgomiuiAX3Wrp9FQ8a5Mtnlhk1cRc1J8ws xiyJpLeLz81glJAqnme7rcxlgddOLVAopYzbTWQvcj4fAd3dq840SIQKJKudQKGpaiwJ XMTQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=hFIjIfys; 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 Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id 83-20020a630156000000b0046b19725686si13839879pgb.775.2022.11.22.10.50.24; Tue, 22 Nov 2022 10:50:46 -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=@infradead.org header.s=casper.20170209 header.b=hFIjIfys; 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 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234600AbiKVStT (ORCPT + 99 others); Tue, 22 Nov 2022 13:49:19 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51592 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232366AbiKVStR (ORCPT ); Tue, 22 Nov 2022 13:49:17 -0500 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0F87F8B118; Tue, 22 Nov 2022 10:49:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:In-Reply-To:References; bh=xKyX3vVodLJd24qW93YmnRz/lx6JTsZ1cMhhyQ3baFo=; b=hFIjIfys5H/s99FiUURbhN9wWm ah8E6yPrGCGMlmw+aGIXqGO/XckQ9M8xMwHst5vNS//4GFRh3STNTZnhpJ0q8e1m+wC5wvVa+1CiG DeaO+fIwzk/F5miHH3beu0Z3ZaEO5rDFJKzXr/JT6nbQnXNn2aCC0GOX6jt5I+l60PtBaWLCSEpXK 843Yiu+L6hbMWgcwMZbzvg2vERR5qIgBLnT/TYCf9pYI624B95WTeaaWiLnDnELtDRXs0IQC5M87H rJO+ecKcXPKqxB3VGr0fyItlNHP9xesE5Xb6JTCFEDUSkEdENtqDhwK22/LD8qdzR9DHmce41+Z9Q Ul15GM8A==; Received: from [2601:1c2:d80:3110::a2e7] (helo=casper.infradead.org) by casper.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1oxYKd-006ehz-1q; Tue, 22 Nov 2022 18:49:19 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Steven Rostedt , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH] Documentation: doc-guide: use '%' constant indicator in Return: exmaples Date: Tue, 22 Nov 2022 10:49:09 -0800 Message-Id: <20221122184909.7764-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.38.1 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE autolearn=ham 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?1750223339660285665?= X-GMAIL-MSGID: =?utf-8?q?1750223339660285665?= Use the 'constant' indicator '%' in the examples for the Return: values syntax. This can help encourage people to use it. Signed-off-by: Randy Dunlap Suggested-by: Steven Rostedt Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Acked-by: Steven Rostedt (Google) --- Documentation/doc-guide/kernel-doc.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff -- a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -151,9 +151,9 @@ named ``Return``. line breaks, so if you try to format some text nicely, as in:: * Return: - * 0 - OK - * -EINVAL - invalid argument - * -ENOMEM - out of memory + * %0 - OK + * %-EINVAL - invalid argument + * %-ENOMEM - out of memory this will all run together and produce:: @@ -163,8 +163,8 @@ named ``Return``. ReST list, e. g.:: * Return: - * * 0 - OK to runtime suspend the device - * * -EBUSY - Device should not be runtime suspended + * * %0 - OK to runtime suspend the device + * * %-EBUSY - Device should not be runtime suspended #) If the descriptive text you provide has lines that begin with some phrase followed by a colon, each of those phrases will be taken