Received: by 2002:a17:90a:1609:0:0:0:0 with SMTP id n9csp2298890pja; Thu, 26 Mar 2020 12:52:42 -0700 (PDT) X-Google-Smtp-Source: ADFU+vsgxRUEohD1I2gerLgVx+54ufVLaGurYgCv7nG5BaTq2FJj425kRdSVeZ+DQXkcdOOa2g3g X-Received: by 2002:a9d:1a2:: with SMTP id e31mr1232978ote.30.1585252362514; Thu, 26 Mar 2020 12:52:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1585252362; cv=none; d=google.com; s=arc-20160816; b=oIw0xFWGj3JEzor109owVRMedOIM/z76INasKpDKWzur2XvhNNkQZoKOdyg1aLTPcp CXQx14fCF2fQdhGb6p9nRQwaavmeBpw4nntw1e0UnkgnU0M5RJJRtGJwCO5q8t88LUUZ +/eIAeGAWMHmS5o7IZLigP1WFjjdsr5jqol6Gz0bOZZBDs+AXMcD2wXFxgpGbqeoVDs+ c+RAeqU2hL9hXSIOtFj2NSb5LC3z3lww2kt50FrO+WIIJyJlM3pN1jOiw3Adhb55DaJm 32JcLcmYwK2dLuF2SU/xdfvYlfXlxVW15hPzWb2qMjXhmjRixsP+GTw00PumCz611koj /+5w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=OLUvLY+nXp+cljT/dtIC4FUhcJSJjn2Hq+rlgn0PV5o=; b=eE4LRF2IfVJ6IF88W71fUFLV5yjkmyLYngzl5qAFlQyAE72PLATUAUjCLsNQLe4zfn Nq9BgiG6Ac7W+k8CyVGeXcVH+ARWNa+2uWxfjslPJ8KeynJW+IGEYlEzVaeXx4Q+dhv4 PGQMrBrEXiD931jhhw7BeTgQJK2XYmfxDm4SST6eC1LaKvMWFgr8+fvn53T6TntxOLB1 WMfUk3smDhsT740tkA+xnAttPAnHbQ0Un/2ig6JdoaVfHJ0HYbfN7FZ8LOSa/LfXBbT3 GrSe/Auix0D5Qts8IHpTe/CI9aVZ/NHuR9LDCtAoFSPd9mjlL66o3PdzeeG0XdYkUwX2 ZdxA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id t7si1589173otd.115.2020.03.26.12.52.28; Thu, 26 Mar 2020 12:52:42 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728641AbgCZTwF (ORCPT + 99 others); Thu, 26 Mar 2020 15:52:05 -0400 Received: from haggis.mythic-beasts.com ([46.235.224.141]:51573 "EHLO haggis.mythic-beasts.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726540AbgCZTwE (ORCPT ); Thu, 26 Mar 2020 15:52:04 -0400 Received: from 141.226.115.87.dyn.plus.net ([87.115.226.141]:56456 helo=slartibartfast.quignogs.org.uk) by haggis.mythic-beasts.com with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92.3) (envelope-from ) id 1jHYXp-0002h8-2W; Thu, 26 Mar 2020 19:52:01 +0000 From: peter@bikeshed.quignogs.org.uk To: Matthew Wilcox , linux-kernel@vger.kernel.org Cc: Greg Kroah-Hartman , "Rafael J. Wysocki" , linux-doc@vger.kernel.org, Jonathan Corbet , Peter Lister Subject: [PATCH v3 1/1] A compact idiom to add code examples in kerneldoc comments. Date: Thu, 26 Mar 2020 19:51:56 +0000 Message-Id: <20200326195156.11858-2-peter@bikeshed.quignogs.org.uk> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200326195156.11858-1-peter@bikeshed.quignogs.org.uk> References: <20200326192947.GM22483@bombadil.infradead.org> <20200326195156.11858-1-peter@bikeshed.quignogs.org.uk> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BlackCat-Spam-Score: 50 X-Spam-Status: No, score=5.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Peter Lister scripts/kernel-doc - When a double colon follows a section heading (e.g. Example::), write a double colon line to the ReST output to make the following text (e.g. a code snippet) into a literal block. drivers/base/platform.c - Changed Example: headings to Example:: to literalise code snippets as above. This patch also removes two kerneldoc build warnings: ./drivers/base/platform.c:134: WARNING: Unexpected indentation. ./drivers/base/platform.c:213: WARNING: Unexpected indentation. Signed-off-by: Peter Lister --- drivers/base/platform.c | 4 ++-- scripts/kernel-doc | 19 +++++++++++++++---- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/drivers/base/platform.c b/drivers/base/platform.c index b5ce7b085795..47f4a9b410b2 100644 --- a/drivers/base/platform.c +++ b/drivers/base/platform.c @@ -128,7 +128,7 @@ EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource_byname); * request_irq() APIs. This is the same as platform_get_irq(), except that it * does not print an error message if an IRQ can not be obtained. * - * Example: + * Example:: * int irq = platform_get_irq_optional(pdev, 0); * if (irq < 0) * return irq; @@ -207,7 +207,7 @@ EXPORT_SYMBOL_GPL(platform_get_irq_optional); * IRQ fails. Device drivers should check the return value for errors so as to * not pass a negative integer value to the request_irq() APIs. * - * Example: + * Example:: * int irq = platform_get_irq(pdev, 0); * if (irq < 0) * return irq; diff --git a/scripts/kernel-doc b/scripts/kernel-doc index f2d73f04e71d..732db3dcc402 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -362,7 +362,7 @@ my $doc_com_body = '\s*\* ?'; my $doc_decl = $doc_com . '(\w+)'; # @params and a strictly limited set of supported section names my $doc_sect = $doc_com . - '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)'; + '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(:?)(.*)'; my $doc_content = $doc_com_body . '(.*)'; my $doc_block = $doc_com . 'DOC:\s*(.*)?'; my $doc_inline_start = '^\s*/\*\*\s*$'; @@ -1952,11 +1952,22 @@ sub process_body($$) { ++$warnings; } } - + # $doc_sect is a regex which searches for section names. + # If it matches: + # $1 is the section name + # $2 is a colon if the section name was followed by a double colon. + # $3 is the rest of the content after the colon (or double colon). if (/$doc_sect/i) { # case insensitive for supported section names $newsection = $1; - $newcontents = $2; - + # If $2 is ':', the section name was followed by a double + # colon, so insert a line containing just '::' to make the + # following block into a ReST literal. This idiom is useful + # for an Example section introducing a code snippet. + if ($2 eq ':') { + $newcontents = "::\n" . $3; + } else { + $newcontents = $3; + } # map the supported section names to the canonical names if ($newsection =~ m/^description$/i) { $newsection = $section_default; -- 2.25.1