From patchwork Mon Jul 3 23:20:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 115523 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:9f45:0:b0:3ea:f831:8777 with SMTP id v5csp870398vqx; Mon, 3 Jul 2023 17:16:37 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5CDVrZ0KtHsFp1JHmLlOGEH0CF6hlQuOw3NNbO2Gmaz2vW8Ei5CGtN6ea188Od7853v99+ X-Received: by 2002:a05:6a21:3391:b0:125:5f1d:9dbe with SMTP id yy17-20020a056a21339100b001255f1d9dbemr17390458pzb.2.1688429797131; Mon, 03 Jul 2023 17:16:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1688429797; cv=none; d=google.com; s=arc-20160816; b=w+nIiy2gm79h+60zwShw3oiDSS91SQWLBYQkw9ViTpyMTiCZYLvGEbmvq2IzISqDJd gvGVyfD/UAGBk3ne6bg0iWEgT3PwAiMt7NRxfWzsBW6wOi5Wtbb4WC3733ZkPSGWUA+E IXTfwCgKIgIHKcP9iT5yPmvCipn48HEdSVQINNEIskW0DZ1DZhVl6lxqkoYBwf3Kg2WV dZOCoBdF36wqRoDFUvZTEk/olsoXGggTBsdGjdRjLR8MTT8TDZ4y+9B5m3+5Gp8c9dun xKcwVmmMPk9nHe2ziullBtLCOMmg/6oO3mqMUuw7/BVfc5Lqh3zmmc0l6z0IypGvWPAo m9pQ== 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=Nu99USUU6jpfHVpJTuMfsxF1uHMhHynmGtK6IjoQ0TE=; fh=HF1gY6CzAEkkMDeaAWeKGK7v3c96C4osHfWK1CZLRMg=; b=WX2sOAP3lGln0eDYYM7pXX7jADup7gsY/BQGhUu17wilK1ZR9FPu+jOXjfPjqpEwXN 7OzeQ79CNTj0NvpVCbX+71ZjGOO4kGrnsmlrp+RToLOtq+LnEhCouYJJ5ZdPf0+NxUIx q5Dw9cn8FIc+lNxaLgsij4mvlTchLDO7596BEbrFtTOIN5aqTkPxy5ez6RcQEabASsmV cqpo6yzdctJGACxAt6MD4ifzsutdSrn0F6/ual1kVbvd+zRXRmIaYh2qiti+Qd0bGSp0 pGmdXLRcnrY+AGvP265U42+aQhMDlXz38WuhuN0xvnP1U95t/3armecHD+m75O0jMg4D RbnA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=cbjVzZP+; 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 y64-20020a636443000000b0054fd88c3598si19413508pgb.35.2023.07.03.17.16.25; Mon, 03 Jul 2023 17:16:37 -0700 (PDT) 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=bombadil.20210309 header.b=cbjVzZP+; 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 S229662AbjGCXUe (ORCPT + 99 others); Mon, 3 Jul 2023 19:20:34 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49134 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229610AbjGCXUd (ORCPT ); Mon, 3 Jul 2023 19:20:33 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9A067107; Mon, 3 Jul 2023 16:20:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; 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=Nu99USUU6jpfHVpJTuMfsxF1uHMhHynmGtK6IjoQ0TE=; b=cbjVzZP+5ZZTwpEE3bpE9TTnkO 2qRHtSkDL0cX6yXr7IDOkD6esvZu1Ob5B2No5BEzLhfguBZ3S6+PYUNmRffXWh0ej86COjUWzv5xM V5EN8TccP2ggmtX6+B8JtaihT6juoYUz9HFLxP4uaBs8lG4mHBLminaZAquCJjWSrYceGWx3QW2yJ 4W5oJyf/KRi1mSqkbAU3wxSm8MiMdpXTEEXyFjoP453He8biCVlxu/FENAPTkRZ4Cdwe/qiy7F+3t Ry8N60LtSBBTjbbce72xR491CPbl+AKXw0gx4QprXirNd+DFurClB5KlunZM1ji7gJjhVVajmqQ4X 1XR+jL2g==; Received: from [2601:1c2:980:9ec0::2764] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qGSqN-00BcxB-1Z; Mon, 03 Jul 2023 23:20:31 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Steven Rostedt , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH v2 RESEND] Documentation: doc-guide: use '%' constant indicator in Return: examples Date: Mon, 3 Jul 2023 16:20:30 -0700 Message-ID: <20230703232030.8223-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.41.0 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,T_SCC_BODY_TEXT_LINE 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?1770446963111577163?= X-GMAIL-MSGID: =?utf-8?q?1770446963111577163?= 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 Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@gandalf.local.home/ Acked-by: Steven Rostedt (Google) --- v2: in Subject, spell 'examples' correctly; Add Link: and Acked-by: Steven add Note: Note: %-ECODE or -%ECODE both work well. 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