From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A3B2AC433FE for ; Tue, 4 Jan 2022 02:00:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231982AbiADCAE (ORCPT ); Mon, 3 Jan 2022 21:00:04 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54120 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231214AbiADCAC (ORCPT ); Mon, 3 Jan 2022 21:00:02 -0500 Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BB628C061761; Mon, 3 Jan 2022 18:00:01 -0800 (PST) Received: by mail-wr1-x42e.google.com with SMTP id v6so11317727wra.8; Mon, 03 Jan 2022 18:00:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Sp130HD3zIYsSZ4ZeBgOvYhLOCokJf2r9bj1XbETQp4=; b=U6THxrv/6sj0TbR2QAfYWPnEKzRF4ic9BxyhDRkznGShDjaZXQWHdpBWi6jRimep8Q T/aSWZZ7n+b6QaxFUbvfJhAO0QswkuM3ZHiMjyP5NeuhGCjoV9vtoxzWtFW47JDAYawM DPRNxcNB4dHIA86tikvcUzeogAdWvbjm58g/W7YlrrSOkievmIgIh3kQLRhwbP0ya+90 5wRMHsLlQSIFnSbleaulfXEIyFyUw1A4MLRyd0Cv6x75XVap8lh/4Zyx6JCfxB0CMvwP P1fXsAlXBYZcpy3RN69PV4vfMYQmd2/8SzxuC/IlGlDHl65zrqMD+JAvJBCx9OrGoqEt S79Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Sp130HD3zIYsSZ4ZeBgOvYhLOCokJf2r9bj1XbETQp4=; b=EcqXPLrXtWgn1RJaEaspUDC8yk4fBtEpgE5Wd656ohyCwntUsqpxxMNwOcQ5sDgM6h gAb82hwKcrgo97sPqawDulDqGDLqOfmu7UHAjw/SnY3NIwX58sBD0/WEXEsq5/mrJJ3g lijI28tN2bE7Gm4F+8tPA+Tt/n4qlWzfN2j2VzngwsvJjjTkEOqn751RmTQqzB2wr2ji AdDj2IN08yd9pVIpeTGWZ8BTw/DbGjK7T4W2usrdDnG/IOrx205wgeZ1ncccPHnXG/Xq EUAhSFnhwaZ06kReL3soiXBuZ3fv4r7JqwiI7rGwGn2yQprGmfI9ieTHqXY3+0o0BWB3 YnzQ== X-Gm-Message-State: AOAM531DaCf91BTqkXo97TmpeceojZSMLem1QbjTRizA2K+DlEEUp19n i37Xxvi1lMFsnA05XksRr8s= X-Google-Smtp-Source: ABdhPJw6X9LwRSVl0dOEBmg+dT5ZmEAkP+/NAjAN5yvYeLxNjlBtLfUReerB++wsC8BqqnWSOuLR1g== X-Received: by 2002:a5d:5348:: with SMTP id t8mr40414912wrv.439.1641261600386; Mon, 03 Jan 2022 18:00:00 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.17.59.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:00 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 01/15] scripts: kernel-doc: Add the NAME section Date: Tue, 4 Jan 2022 02:59:32 +0100 Message-Id: <20220104015946.529524-2-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org You can see the POD with: $ perldoc scripts/kernel-doc * Transform documentation into POD (1/15) =3D Series explanation =3D This series transforms the free-form general comments - mainly the usage instructions and the meta information - into the standard Perl documentation format. Some of the original text is reduced out. The transformation includes language, paragraphing and editorial corrections. The only change in the script execution flow is the replacement of the 'usage' function with the native core Perl 'pod2usage'. The TODO suggestion to write POD found in the script is ancient, thus I can't address its author with a "Suggested-by" tag. The process consists of 15 steps. 1) Add the NAME section 2) Add the SYNOPSIS section 3) Relink argument parsing error handling to pod2usage The following subseries is disfunctional before its last part. 4) Translate the DESCRIPTION section 5) Translate the "Output format selection" subsection of OPTIONS 6) Translate the "Output format selection modifier" subsection of OPTIONS 7) Translate the "Output selection" subsection of OPTIONS 8) Translate the "Output selection modifiers" subsection of OPTIONS 9) Translate the "Other parameters" subsection of OPTIONS 10) Replace the usage function Here the DESCRIPTION and OPTIONS subseries is finished. The -h and -help parameters are handled by POD now. 11) Remove the "format of comments" comment block 12) Archive the pre-git museum 13) License cleanup 14) Refresh the copyright lines 15) Move the TODOs Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 3106b7536b89..46d3e779bf5d 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -16,6 +16,12 @@ use strict; ## This software falls under the GNU General Public License. ## ## Please read the COPYING file for more information ## =20 +=3Dhead1 NAME + +kernel-doc - Print formatted kernel documentation to stdout + +=3Dcut + # 18/01/2001 - Cleanups # Functions prototyped as foo(void) same as foo() # Stop eval'ing where we don't need to. --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2B652C433F5 for ; Tue, 4 Jan 2022 02:00:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232158AbiADCAI (ORCPT ); Mon, 3 Jan 2022 21:00:08 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54128 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229634AbiADCAD (ORCPT ); Mon, 3 Jan 2022 21:00:03 -0500 Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 75466C061784; Mon, 3 Jan 2022 18:00:02 -0800 (PST) Received: by mail-wr1-x42e.google.com with SMTP id r17so73017199wrc.3; Mon, 03 Jan 2022 18:00:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=6mi3lXLotPeA8OuZcUtL4/v/VSJqoUbLVNYdECb0ITQ=; b=B1/VG2Wvv78ikbvTlEp9y4WElUCB2staDTZ9bZmW2366mf3aGh6jHF/fCp+K6eoQJw Cy7UwsXnxFA5IaAzOWT6x7mfBMmFDppyemGojVNf+ud0WP4NWUBRng2rXM7fFDMmuOAQ R4LA4MoCICy8lVmLUBxuLLAeST3JeNhs4XsltpG78lJ1C5btE9obli2jS9H3y+e941uN 1TcnvO0rp/vHgsJJuJO9fW+0O84aPObQIAbXq/aVaPPXya/ZedCqSlPzCrROjWemTUht XZDUbK08Nu3Fl42bUMWtvo5yi6U5MLO6glGDeFGrk7XGKZMmHh2zMxXz8Ofae8MqsDJ1 19Gg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=6mi3lXLotPeA8OuZcUtL4/v/VSJqoUbLVNYdECb0ITQ=; b=d8JaMMJfOSNBq8mjK12XZ4Xpd+JOB0iXABudFhOVU8DyMizmjFyVhDoPkSCjlL5QcY QBAWHF5ncMH7+J323GkARFZ4UERMLb69HV6cfHT4iAnOr3NmSMGkihGYx3DTebOmF+lM meWogFnNivD99tzRq7Ccqqgk9mnk1vhi0e7jmPCuDHyh/aCvk8O+6wLZuvlHoFo0rLH/ KVtdEL6qa/brnQtUdUpZoBbZTNON6Mb8Osq1+HXdCCr+5hKf94uivnuFIsNBatk+VULv 1t6mfw2M/SpQTs9JjpqeHKXmDHcUB6rgbGJKf5rDi46Q4V9K6bO9n59+g47B3v/4tkXd 3wDg== X-Gm-Message-State: AOAM530DgN1mW1uMuW3QZYrQ7sdA4uc6cdVC8bhu/gTztlt0b1MNKV4w WVwGY0NyxnFXnurqVuwO7U/PRAx0jUo66w== X-Google-Smtp-Source: ABdhPJwV1uQFBq1uFtsfRCSzedoy7vXBSw473zSo0ewjA1+ntu5aU2rOlXbZnkgwt7810aFZY4ZSwg== X-Received: by 2002:a5d:634c:: with SMTP id b12mr38309662wrw.388.1641261601132; Mon, 03 Jan 2022 18:00:01 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:00 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 02/15] scripts: kernel-doc: Add the SYNOPSIS section Date: Tue, 4 Jan 2022 02:59:33 +0100 Message-Id: <20220104015946.529524-3-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Rst-only options are grouped around rst, the rest is arranged as in the OPTIONS susections (yet to be translated into POD, check at the end of the series). * Transform documentation into POD (2/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 46d3e779bf5d..c8fbf1d3d5aa 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -20,6 +20,25 @@ use strict; =20 kernel-doc - Print formatted kernel documentation to stdout =20 +=3Dhead1 SYNOPSIS + + kernel-doc [-h] [-v] [-Werror] + [ -man | + -rst [-sphinx-version VERSION] [-enable-lineno] | + -none + ] + [ + -export | + -internal | + [-function NAME] ... | + [-nosymbol NAME] ... + ] + [-no-doc-sections] + [-export-file FILE] ... + FILE ... + +Run `kernel-doc -h` for details. + =3Dcut =20 # 18/01/2001 - Cleanups --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2783CC433EF for ; Tue, 4 Jan 2022 02:00:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232218AbiADCAK (ORCPT ); Mon, 3 Jan 2022 21:00:10 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54134 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231294AbiADCAE (ORCPT ); Mon, 3 Jan 2022 21:00:04 -0500 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 070E9C061761; Mon, 3 Jan 2022 18:00:04 -0800 (PST) Received: by mail-wr1-x42b.google.com with SMTP id s1so73039895wra.6; Mon, 03 Jan 2022 18:00:03 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=U4A1ya3ZBhppFb6gPFviCdTS1d/Uqn0YN2yJAph1WIE=; b=OHwgWD7Po00ldCLP+AE+QxysIQb20FxtObobjDDjIKvJMuOjLe8zMejppC/0nwXIo8 dXLR/KQOxXo1NDUhKWb22DZk3Zgv2TVwpkLIe6lPedE0XV25M/gie/QnTntPwbGv2fU0 nbPnQ/XbA/d8tW4F7cYUzVSxwi8JqwpM7pcpyE8WiHJbCYu2qyM8PGQphnxmtQzLbAZr rmIp0a61utnyp/PirlhYS82E3yTrDUswBo6L8OcUr7AeJCxppA8JJ/CHwfynYZ50Bv5D zuK9wLdSZectMyWvi55D8pgwF/asuKZGM1mUtETWZEWhPAnVuKpsCCr1FUUNM87dSv/4 FCvA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=U4A1ya3ZBhppFb6gPFviCdTS1d/Uqn0YN2yJAph1WIE=; b=A3HTkDLDqVa3Z/Exun+X/xPv+ZlTZC90pwgaDKWXI8gZuGaXz8QRPQfWC6WjZBncH0 KULtBzXmzXv7OWuWqm33VXXQtw+4/b5ay/zlYFpD7atk2pzJTVM8f2XOC+6crEbER2FG 14DWTV/O1xeLomMwkkDOofQcxmZNxDjRBfYQZTtrZcJV95KHscaaDoUulIgHiCivPE// KAPCCw3z+wc6Z7T0lBbtGrqAzzy3FUEtWEC6zDauI2tFZTaB8+kNpHWDLCj1N3sMGBp6 hr6rvp88BC6ixJgrmHSpB+6X0IIF6QVZazSJzthvthB8WvNg3/sP67kRDKBNzPCcPz7d C+FQ== X-Gm-Message-State: AOAM530jNgFo+dWKJguKvOZbYxeBZI4ZZJXVbO+1dCHD4SN9RnTXX6EL LuuE9uS9euo7agpNVNRh8Jw= X-Google-Smtp-Source: ABdhPJzORNa4c0cguimtZxz/MEcO84ft6UeieEyu0yBpqGP3PEuKalVXRFCkAFnwoo2QqSFPGK2kAA== X-Received: by 2002:adf:c445:: with SMTP id a5mr22712967wrg.631.1641261601927; Mon, 03 Jan 2022 18:00:01 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:01 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 03/15] scripts: kernel-doc: Relink argument parsing error handling to pod2usage Date: Tue, 4 Jan 2022 02:59:34 +0100 Message-Id: <20220104015946.529524-4-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The former usage function is substituted, although not as the -h and -help parameter handler yet. * Transform documentation into POD (3/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index c8fbf1d3d5aa..c37fd36860f3 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -16,6 +16,8 @@ use strict; ## This software falls under the GNU General Public License. ## ## Please read the COPYING file for more information ## =20 +use Pod::Usage qw/pod2usage/; + =3Dhead1 NAME =20 kernel-doc - Print formatted kernel documentation to stdout @@ -298,7 +300,13 @@ my $blankline_rst =3D "\n"; =20 # read arguments if ($#ARGV =3D=3D -1) { - usage(); + pod2usage( + -message =3D> "No arguments!\n", + -exitval =3D> 1, + -verbose =3D> 99, + -sections =3D> 'SYNOPSIS', + -output =3D> \*STDERR, + ); } =20 my $kernelversion; @@ -518,8 +526,14 @@ while ($ARGV[0] =3D~ m/^--?(.*)/) { die "Sphinx version should either major.minor or major.minor.patch fo= rmat\n"; } } else { - # Unknown argument - usage(); + # Unknown argument + pod2usage( + -message =3D> "Argument unknown!\n", + -exitval =3D> 1, + -verbose =3D> 99, + -sections =3D> 'SYNOPSIS', + -output =3D> \*STDERR, + ); } } =20 --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 64BBCC433EF for ; Tue, 4 Jan 2022 02:00:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232239AbiADCAL (ORCPT ); Mon, 3 Jan 2022 21:00:11 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54136 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231315AbiADCAE (ORCPT ); Mon, 3 Jan 2022 21:00:04 -0500 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3A005C061784; Mon, 3 Jan 2022 18:00:04 -0800 (PST) Received: by mail-wr1-x436.google.com with SMTP id d9so73119752wrb.0; Mon, 03 Jan 2022 18:00:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ZovIGBSj8XwnFs6zndR1wYzs7e7U8XwYk4aDPF6CluU=; b=FewZdPJAGatSLciSWmMjUP7X6nVyP54DYajS6s05t7HKRn7xNOb3yiomVj074nD8r2 jCQFFhfT2pCa7aEzqYq+Txer9PDfQ5LAftQM3NDsbue1Xcdrmkw3V29blmuE9L4ImcEK PyKhblrEZUo55bvYbrPxIaJFI93HymqOT6jL7Ap7ae7xTDKnoCfBjLcL+TWay8+iWvRQ vd5RDQdoKPZNveyW/dqxNBNswCaloyNE5Ll+wS+QudTrREwNmztn/M+D2gZDb3n/mJNn CY2F8s3L0inopwjObVEGBYyKzDJqFhXSBn5Qe13Vun/XE/Gc0wqwRhSm0eKpwgWmHcED zwTw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ZovIGBSj8XwnFs6zndR1wYzs7e7U8XwYk4aDPF6CluU=; b=MyE5MJ3WhYJowxh+Roryh3o0zzB3eD58qZkrhbLWWRlL5K1pJq364TO0ozkPowMuHK vg0JvW0/BXeZ00+RpIGr1t8F8tbMRGebNksvS3Bjc3vyWYGbZcmNnnID/TyUdX45Q1BI 16BJciRbemVLdPSO3kBeNj821a2gTSFljARR9hU5u6IaBe2cG+oUcfYOnCv5KB2seBA+ jd67qxBUZfhs73e7hkHrZk0V6WmP7I6cJ4tabnWFubD0qnTznEcVVMEHqtJ5GdZxAEFn aEb/zIF3j1z46R7Tk9F6UbiAejVcKVQn3YtilamU3tW5j84fjfRtzPPjJtWuprRCZSxW NPag== X-Gm-Message-State: AOAM530UeA2pURp/yrjn8F+QUFiQ2VQqAbJ7CmmkcvbdrxeNSXTiu7II pxuTEov4pGnGHuo6lC959g0= X-Google-Smtp-Source: ABdhPJwHLZZwvlYx0LZUeK3m2MTTLceOP0FkfDMgrHJIZvut9Nv2fye8dby6wDTCnlIXlbrXJ4OOqQ== X-Received: by 2002:adf:d1e2:: with SMTP id g2mr42105642wrd.105.1641261602827; Mon, 03 Jan 2022 18:00:02 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:02 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 04/15] scripts: kernel-doc: Translate the DESCRIPTION section Date: Tue, 4 Jan 2022 02:59:35 +0100 Message-Id: <20220104015946.529524-5-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Notes: - an article addition - paragraphing correction * Transform documentation into POD (4/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index c37fd36860f3..4d0b38c82bfb 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -41,6 +41,15 @@ kernel-doc - Print formatted kernel documentation to std= out =20 Run `kernel-doc -h` for details. =20 +=3Dhead1 DESCRIPTION + +Read C language source or header FILEs, extract embedded documentation com= ments, +and print formatted documentation to standard output. + +The documentation comments are identified by the "/**" opening comment mar= k. + +See Documentation/doc-guide/kernel-doc.rst for the documentation comment s= yntax. + =3Dcut =20 # 18/01/2001 - Cleanups @@ -72,12 +81,6 @@ sub usage { my $message =3D <<"EOF"; Usage: $0 [OPTION ...] FILE ... =20 -Read C language source or header FILEs, extract embedded documentation com= ments, -and print formatted documentation to standard output. - -The documentation comments are identified by "/**" opening comment mark. S= ee -Documentation/doc-guide/kernel-doc.rst for the documentation comment synta= x. - Output format selection (mutually exclusive): -man Output troff manual page format. This is the default. -rst Output reStructuredText format. --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 976A3C433F5 for ; Tue, 4 Jan 2022 02:00:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232272AbiADCAO (ORCPT ); Mon, 3 Jan 2022 21:00:14 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54146 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232023AbiADCAF (ORCPT ); Mon, 3 Jan 2022 21:00:05 -0500 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 19AB9C061792; Mon, 3 Jan 2022 18:00:05 -0800 (PST) Received: by mail-wr1-x435.google.com with SMTP id e5so73035706wrc.5; Mon, 03 Jan 2022 18:00:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=YYgfZnQEoOcAY409R8rAQypLrB633uHUXM6T9j56ZIQ=; b=WrSJb9sDXxdGsDSdszh3NbDoV0v9gHcUQEKFyoY1AqJziwJB33V1+75zY98krG5sd4 sjl7K7vI+O1HaG1ZSl5OT26LIbFfO+CQd8qncryE0KUIdpIayeW4eoMcVLB1Y3k9/ESu JpzFQ6YKH0VlDbqYJYNoMASkz+V+2Mn2Jd9onhZRSODzaadRiu/9f8oCt+29BD10S8Va 7oV152M8PHj+pDGuwarIFLEcvnCYnqby3eesg06vGGjTQ6shoCmrRePOKpJsLcy69ihC qqbm5wkvV+5+TV74dJx6tzQVb9fuuxV6eJVX3VoWJpO5VICd2wvq0KlJkB2GMKUIERrJ 6Tjw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=YYgfZnQEoOcAY409R8rAQypLrB633uHUXM6T9j56ZIQ=; b=eJ8iqqxfCFSFoOZgZ8ziwWAIdBofxjWLVOgHR8vRW2qjzdOnNR4y4IGB0Puvg08lj3 nRKpuwqjgRflp6UopiNA/rsSimw3hmaJTetjz35Puk6x79VPR7rjh+JV4VHuXIZEI/Rq cIGDSa5GOtGZzvzm+RYAbirhMAWE8zqInvPOnPbpgALgv2XMFfh1pXo7k+QFKqpnOOhm XE8cKNaW3boOlo8Ij5z+o32/7A7YT1CpC7dfvwjDdm5ZE0lzLqDjjuIkiTpTy+FKA3ih 4WrK00TM2b3A5eq/MQxLyj/KzVH26gkUKgt33y6pttMLvpV/UepOYLVT5VrZaYXcJn92 6VWg== X-Gm-Message-State: AOAM5331UWNV8W3CcgeDLqrxj4Zs3mSLZt/r9B/FVz0oGyccxjFbaq6Q 42DMH/o2V0GKXAhaxFYA9nM= X-Google-Smtp-Source: ABdhPJyAOIFiTAQRIzAn2pqNmtOz3xP5LAd36aQvwVzofpYEf7nn4dWS9vckdTRxyHm3DPH7rKX44A== X-Received: by 2002:adf:efc6:: with SMTP id i6mr39575714wrp.428.1641261603749; Mon, 03 Jan 2022 18:00:03 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:03 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 05/15] scripts: kernel-doc: Translate the "Output format selection" subsection of OPTIONS Date: Tue, 4 Jan 2022 02:59:36 +0100 Message-Id: <20220104015946.529524-6-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Options land at the end of the script, not to clutter the file top. The default output format is corrected to rst. That's what it is now. * Transform documentation into POD (5/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 4d0b38c82bfb..8213399fd7ec 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -52,6 +52,8 @@ See Documentation/doc-guide/kernel-doc.rst for the docume= ntation comment syntax. =20 =3Dcut =20 +# more perldoc at the end of the file + # 18/01/2001 - Cleanups # Functions prototyped as foo(void) same as foo() # Stop eval'ing where we don't need to. @@ -81,11 +83,6 @@ sub usage { my $message =3D <<"EOF"; Usage: $0 [OPTION ...] FILE ... =20 -Output format selection (mutually exclusive): - -man Output troff manual page format. This is the default. - -rst Output reStructuredText format. - -none Do not output documentation, only warnings. - Output format selection modifier (affects only ReST output): =20 -sphinx-version Use the ReST C domain dialect compatible with an @@ -2563,3 +2560,27 @@ if ($Werror && $warnings) { } else { exit($output_mode eq "none" ? 0 : $errors) } + +__END__ + +=3Dhead1 OPTIONS + +=3Dhead2 Output format selection (mutually exclusive): + +=3Dover 8 + +=3Ditem -man + +Output troff manual page format. + +=3Ditem -rst + +Output reStructuredText format. This is the default. + +=3Ditem -none + +Do not output documentation, only warnings. + +=3Dback + +=3Dcut --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8D20FC433F5 for ; Tue, 4 Jan 2022 02:00:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232282AbiADCAQ (ORCPT ); Mon, 3 Jan 2022 21:00:16 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54152 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232141AbiADCAG (ORCPT ); Mon, 3 Jan 2022 21:00:06 -0500 Received: from mail-wm1-x336.google.com (mail-wm1-x336.google.com [IPv6:2a00:1450:4864:20::336]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ECEE4C061761; Mon, 3 Jan 2022 18:00:05 -0800 (PST) Received: by mail-wm1-x336.google.com with SMTP id g191-20020a1c9dc8000000b0032fbf912885so678215wme.4; Mon, 03 Jan 2022 18:00:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=qSfgUsvhrjJaj+G06o0Ido86WeZkW3i/4hxs0h3tr6E=; b=CCCgJTZN3rtxZIHNytt4bl8ONJ/DZs2q8wXMlQRKuNULK8O0fRiBzfEGgsHG7AizTL mDosvpqXEywar4Csc1yZ6s+wg/ELCy6bxLasavU2AK5oA7J33QxkslWQgHQpsoKb9LLU nBu5KZ2EBET7TrN7fwJAn0Ca+u557ksK519umuCMM/EDjRd4zbDs7hQ4gd6B/TmzCzsC WD8S4HWmCp51uk6UaUtvZNR7nA5PqtDsp+hkNpyS4d3UQfQ+/HARtezz3swrs35hPgXQ Yr2ZEp00hnp5mDd4oRxQ+mSBYguKHBsbjGQDA9ZQWrKAft07xmoFE+qL/d3rwP7pe/F6 CDQw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=qSfgUsvhrjJaj+G06o0Ido86WeZkW3i/4hxs0h3tr6E=; b=zmxQr8eKERyGjoVzI7SEiUGytIiDNO5PVLa/1AIDgXwR/7Vf/fTEJW5LSs0NrdYADD JS0PTxyde72xFZEnXXk7nY9Hw+MB2WJ5jlpYF8WIHix27nibEf8T8ANj1BBkQJHQ44Ni ZEr5/CXoxHHyxhn9hDqPnDn3PaVCM5kBG22iAtamK/X/NEl+xVoLcgVul/rINK9QVOY6 MK6uuKtEMy+UvbYTR52HVd51cSiz68G04O+DCBgWN7N1xrpr8zuVYDLN8EHRUdCaDg+Y Ll1NhGFMK6yt4sV/u5unUFjRT9xMmQienXO/+k8Z6G1Ll2I0Y+DQeG1RCK+bW+nQhZY2 RQKw== X-Gm-Message-State: AOAM5305EcopFpPOYvJWXel/dFGRJbuF1PNpsom8NV82WMCDZWuIsUdg TH1yzhr5eaiD2yg2P3DejrW2u0vSGwpR/w== X-Google-Smtp-Source: ABdhPJz5KcmJIUAqPsM4oWJNIuwJSHwY9vQhpRSr7WP7t+0hVLZ26QiK4awWz2AGcFcw7Rd4pwxibA== X-Received: by 2002:a05:600c:4fcc:: with SMTP id o12mr39733215wmq.184.1641261604570; Mon, 03 Jan 2022 18:00:04 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:04 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 06/15] scripts: kernel-doc: Translate the "Output format selection modifier" subsection of OPTIONS Date: Tue, 4 Jan 2022 02:59:37 +0100 Message-Id: <20220104015946.529524-7-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This section is renamed to "Output format modifiers" to make it simple. To make it even more simple, a subsection is added: "reStructuredText only". Other notes: - paragraphing correction - article correction * Transform documentation into POD (6/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 8213399fd7ec..f26966dd8bde 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -83,13 +83,6 @@ sub usage { my $message =3D <<"EOF"; Usage: $0 [OPTION ...] FILE ... =20 -Output format selection modifier (affects only ReST output): - - -sphinx-version Use the ReST C domain dialect compatible with an - specific Sphinx Version. - If not specified, kernel-doc will auto-detect using - the sphinx-build version found on PATH. - Output selection (mutually exclusive): -export Only output documentation for symbols that have been exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() @@ -2583,4 +2576,19 @@ Do not output documentation, only warnings. =20 =3Dback =20 +=3Dhead2 Output format modifiers + +=3Dhead3 reStructuredText only + +=3Dover 8 + +=3Ditem -sphinx-version VERSION + +Use the ReST C domain dialect compatible with a specific Sphinx Version. + +If not specified, kernel-doc will auto-detect using the sphinx-build versi= on +found on PATH. + +=3Dback + =3Dcut --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 65DF4C433F5 for ; Tue, 4 Jan 2022 02:00:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232238AbiADCAS (ORCPT ); Mon, 3 Jan 2022 21:00:18 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54160 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231309AbiADCAH (ORCPT ); Mon, 3 Jan 2022 21:00:07 -0500 Received: from mail-wr1-x42c.google.com (mail-wr1-x42c.google.com [IPv6:2a00:1450:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D2FEEC061784; Mon, 3 Jan 2022 18:00:06 -0800 (PST) Received: by mail-wr1-x42c.google.com with SMTP id e5so73035882wrc.5; Mon, 03 Jan 2022 18:00:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=tjAkEHNcdl0hsyrkAlIgXS8/cjp5tCrQhI1C/+QzliQ=; b=Ranw6u3xv/cq1XygBK7vLEkyCiFvqYUYFdBS4T5P4VKP80U0XuEfZy2OjOwfUxx07G 3oWAHi4i5YJtFQQpdv8B1plHjcYYNHV58vQCwXhyAUdiaDXuKPisnna4GEBoCM7oKnAz 3d+RUivaHeZpyKut00km24t9wRpDEN7+wZg84Nav+YOcCX4zoKMwDsYyhQVCXYJJQxhT uVhBoc51aedX+n0cofmRSBnoF3W1fwq7VU8kWRcHhTrAdXkKV/ErQE1AaKFZQHGBjWwP ujkONFPfj//hxUxGFJ1NccN9T/gK81w3KfrYqacjocW0x3yzJJ5GkwHCLmHeukfyg7+1 TcPA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=tjAkEHNcdl0hsyrkAlIgXS8/cjp5tCrQhI1C/+QzliQ=; b=CEKKgtLeJYh1//pQNuvpOCuZAqwHq2VRbK9JMdCNmQt38+iJbIaWQ7jUCBkrYksU+D 0/CpfCIBTNCS9veS9gpIOf9rr/haZqxzO9YiUfwsNe4oQNBufp0Iuzl6zKJVlhhyO8Ps oo4u0K8i0NduzwjO8wreyhaohBMZZjujlwbPHB4pAi9a77cI/UB5J2ZmZK82Zi5nvpcE smX5C3iL8CyTvh1iW5ZV7G9aBVDIkThD8LtQNES1tgHCT0M0wkk9j6eO++VvpqaocpKW Zd+QjLu0vDKKkGn6kii72E2n8w/7buZ8UzuBja5JRfK7MkPMN0dCwsBWp5o/GOWSRrin 8rxQ== X-Gm-Message-State: AOAM530tWTwZzF9WDaIi8NNmX6BSKTHXtvkBSSG0UqToUTP9oeM8LmpU 7vEiaJRgWFimjf86fu5H25upyfcb/tVH+w== X-Google-Smtp-Source: ABdhPJxpox9Ga5u9J8PN+X4fuyeJWjb1A032efhp299iKLtlD/YdOuNZ1L787w6k8q7zqVR83Uwr3A== X-Received: by 2002:a5d:5746:: with SMTP id q6mr40712678wrw.163.1641261605535; Mon, 03 Jan 2022 18:00:05 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:05 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 07/15] scripts: kernel-doc: Translate the "Output selection" subsection of OPTIONS Date: Tue, 4 Jan 2022 02:59:38 +0100 Message-Id: <20220104015946.529524-8-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The plurals in -function and -nosymbol are corrected to singulars. That's how the script works now. I think this describes the syntax better. The plurar suggests multiple FILE arguments might be possible. So this seems more coherent. Other notes: - paragraphing correction - article correction * Transform documentation into POD (7/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 42 +++++++++++++++++++++++++++++------------- 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index f26966dd8bde..629ba514db5d 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -83,19 +83,6 @@ sub usage { my $message =3D <<"EOF"; Usage: $0 [OPTION ...] FILE ... =20 -Output selection (mutually exclusive): - -export Only output documentation for symbols that have been - exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() - in any input FILE or -export-file FILE. - -internal Only output documentation for symbols that have NOT been - exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() - in any input FILE or -export-file FILE. - -function NAME Only output documentation for the given function(s) - or DOC: section title(s). All other functions and DOC: - sections are ignored. May be specified multiple times. - -nosymbol NAME Exclude the specified symbols from the output - documentation. May be specified multiple times. - Output selection modifiers: -no-doc-sections Do not output DOC: sections. -enable-lineno Enable output of #define LINENO lines. Only works = with @@ -2591,4 +2578,33 @@ found on PATH. =20 =3Dback =20 +=3Dhead2 Output selection (mutually exclusive): + +=3Dover 8 + +=3Ditem -export + +Only output documentation for the symbols that have been exported using +EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file F= ILE. + +=3Ditem -internal + +Only output documentation for the symbols that have NOT been exported using +EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file F= ILE. + +=3Ditem -function NAME + +Only output documentation for the given function or DOC: section title. +All other functions and DOC: sections are ignored. + +May be specified multiple times. + +=3Ditem -nosymbol NAME + +Exclude the specified symbol from the output documentation. + +May be specified multiple times. + +=3Dback + =3Dcut --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id EA247C43217 for ; Tue, 4 Jan 2022 02:00:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232310AbiADCAT (ORCPT ); Mon, 3 Jan 2022 21:00:19 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54168 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232144AbiADCAI (ORCPT ); Mon, 3 Jan 2022 21:00:08 -0500 Received: from mail-wr1-x430.google.com (mail-wr1-x430.google.com [IPv6:2a00:1450:4864:20::430]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B5906C061792; Mon, 3 Jan 2022 18:00:07 -0800 (PST) Received: by mail-wr1-x430.google.com with SMTP id k18so36320295wrg.11; Mon, 03 Jan 2022 18:00:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=RvN39auXSxEz3WOh3mbUKrKWbJFq9xjM+ARLeHF7XJA=; b=E+iRebTNc1QINxn+tRVV/ejzbCWTHUHCfCHElzh3GPhWgZkETrYle1m1wAOreOL0kz 4TkUvp2cUQde9Sbt+01uBROw8cA/OmJg8g8a+QPGWeN21EH9P6FDdKMZBRWmpPfYlOtX 6HKZAhKtLhEd7z95qwuQ4wcOnGMdIWDg64oZxCcVVX/VUxDqWhnWfjAxotSO/bLSnlXB 6grn/YXQYYfq9bqUXGKteMyliEfmlu2KmQzAivuM1OP12TiA+n6/qb+wjZVb0iMP+vqH 1YJ4H+6sQxToXVGQWJYHhz2xJb5FlcDSNgBUdPBrp1bv/iYTPDC4c+PXbL7orvO5q/b8 LNMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=RvN39auXSxEz3WOh3mbUKrKWbJFq9xjM+ARLeHF7XJA=; b=FdiuIbqFLrUJ9xu96Q0RmynT4hpqDbTeqR8hwkfFwRHPRSF9jXHb17p9g8mW/UUlnZ Kw+PB3M2VplSiTyUGY+awYcSWDN7O8KM3qRoClrSIPJl5SvyMgC+VIGVmQBY9bXJmuqi 0l1rHx/gBhtFrmdTrPbyJ3uRwU2ZbooCsOgeOTS7vC4y1eGtlF23bM9a3dk5/r5ROxEH Qrp2GcsvkjMhiOzmsgnI5l6oVWORAgDiSyFJis6lOionhUUkg22X4qpfVx4ovpnipUxC D+dAuXf3LqjA5GMfqVtkpL5Zx/bjrl/479trGFFys+Fppx56b93k0vb5prEAhhzRqNON zVnA== X-Gm-Message-State: AOAM531s+J+jYx4liRbcVxCFYQHttwcBb7TvwoFSXXZ+3leNkHIhQqj+ t1iLGa9rY0tNaTluhyJlAXM= X-Google-Smtp-Source: ABdhPJy7DPvmR/NAUTDj/nYos5SkHQi8UK50RjJ6eh3Z1zOiJCUhBD8fuIlE5x2qyAxsP2Bmx369tw== X-Received: by 2002:adf:e74c:: with SMTP id c12mr40695181wrn.200.1641261606380; Mon, 03 Jan 2022 18:00:06 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:06 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 08/15] scripts: kernel-doc: Translate the "Output selection modifiers" subsection of OPTIONS Date: Tue, 4 Jan 2022 02:59:39 +0100 Message-Id: <20220104015946.529524-9-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org A subsection "reStructuredText only" is added for -enable-lineno. Other notes: - paragraphing correction * Transform documentation into POD (8/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 629ba514db5d..c46d4b9afef2 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -83,14 +83,6 @@ sub usage { my $message =3D <<"EOF"; Usage: $0 [OPTION ...] FILE ... =20 -Output selection modifiers: - -no-doc-sections Do not output DOC: sections. - -enable-lineno Enable output of #define LINENO lines. Only works = with - reStructuredText format. - -export-file FILE Specify an additional FILE in which to look for - EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be use= d with - -export or -internal. May be specified multiple ti= mes. - Other parameters: -v Verbose output, more warnings and other information. -h Print this help. @@ -2607,4 +2599,33 @@ May be specified multiple times. =20 =3Dback =20 +=3Dhead2 Output selection modifiers: + +=3Dover 8 + +=3Ditem -no-doc-sections + +Do not output DOC: sections. + +=3Ditem -export-file FILE + +Specify an additional FILE in which to look for EXPORT_SYMBOL() and +EXPORT_SYMBOL_GPL(). + +To be used with -export or -internal. + +May be specified multiple times. + +=3Dback + +=3Dhead3 reStructuredText only + +=3Dover 8 + +=3Ditem -enable-lineno + +Enable output of #define LINENO lines. + +=3Dback + =3Dcut --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 44599C433EF for ; Tue, 4 Jan 2022 02:00:28 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231439AbiADCA0 (ORCPT ); Mon, 3 Jan 2022 21:00:26 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54178 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232160AbiADCAJ (ORCPT ); Mon, 3 Jan 2022 21:00:09 -0500 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8BF79C061784; Mon, 3 Jan 2022 18:00:08 -0800 (PST) Received: by mail-wr1-x42b.google.com with SMTP id v6so11318073wra.8; Mon, 03 Jan 2022 18:00:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=kYqakpFR2YauOJIseMjLHG8gpVRgifkK6MPT98zhKg4=; b=nUgQ4cgVwAjw5HfFzkBijX4vncjn5xrjqFg+K5Udz32kFb9ql43Z3+diu0OHwxX7hn 4Ybvbpg4RwTJ9tXk1hIpVJ/n+HhyV/uS5PXUjbEp3nu8sdFIbsq74z0x4JV1egMFMxiD wLSAYaCutM3hTKsWCTLC+ETEFlvHoC8aqkBsWc4D7zhxIi3qTMBS55WfWoVJmGFR/1+y etRZbo2aGMNxUSMgOa0OfQhFVlx6xwLJUIj3zudutI8PWhzPf+l1zM/9JB3+wz4FEpPB jkMwiOMNcj0P/UZcl68QD4RHOFFt7C2XUVSAVUYy+qaxN2C5WnoxHlxuvkAP1Dwb/W35 5ngg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=kYqakpFR2YauOJIseMjLHG8gpVRgifkK6MPT98zhKg4=; b=lsKVgCoU+MgZvy1Z+5Xf4pIFLPcOv9efj+zOL9VidajEfuatmPAdMwj9nMLCFDOQrm UuWEWu9t6EkkEaDtYyYqlmqKofqL1Rrh9esTnlZzXc7sZLzUaurVDuMoMdjWghrbUizS owlr21+GB/JACHceHnJivkup85H4ONtLHKXJlMN0fIjH/dgJFX02dnsiA6whMKNUVMZY AzxSCEUYP9UceNT8QYpUFijwQxrKivlpWHcIX+6j24j0lZY+eCAu93oU9e1xmEmk4MAR v6AVF2LcKf0fv2QK/AAsgGnAJkZWebv94ErKM8aarwNimg4oFbNYnYUOwpBTW4U5AvwK KScw== X-Gm-Message-State: AOAM531lvaZ7jlbRWkN1t9zCiF5+9DhVCFXTTiFiSnJYBjG0gWazO1Vr XYcaDFO9DArW24RusXB5NsqNGqWVXJg2Lw== X-Google-Smtp-Source: ABdhPJwUWPWWgg4yTYGvLqw7NqKyUcpgRKvf81FPw+MFhcbYcWS9tHxYqHvWVFoYo+UsUS5x04dWDQ== X-Received: by 2002:adf:ee47:: with SMTP id w7mr40099223wro.368.1641261607245; Mon, 03 Jan 2022 18:00:07 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:06 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 09/15] scripts: kernel-doc: Translate the "Other parameters" subsection of OPTIONS Date: Tue, 4 Jan 2022 02:59:40 +0100 Message-Id: <20220104015946.529524-10-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Notes: - The -help token is added. - The entries are sorted alphbetically. * Transform documentation into POD (9/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index c46d4b9afef2..33e7923683a0 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -83,11 +83,6 @@ sub usage { my $message =3D <<"EOF"; Usage: $0 [OPTION ...] FILE ... =20 -Other parameters: - -v Verbose output, more warnings and other information. - -h Print this help. - -Werror Treat warnings as errors. - EOF print $message; exit 1; @@ -2628,4 +2623,22 @@ Enable output of #define LINENO lines. =20 =3Dback =20 +=3Dhead2 Other parameters: + +=3Dover 8 + +=3Ditem -h, -help + +Print this help. + +=3Ditem -v + +Verbose output, more warnings and other information. + +=3Ditem -Werror + +Treat warnings as errors. + +=3Dback + =3Dcut --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8C3E4C433F5 for ; Tue, 4 Jan 2022 02:00:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232297AbiADCA3 (ORCPT ); Mon, 3 Jan 2022 21:00:29 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54186 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232201AbiADCAJ (ORCPT ); Mon, 3 Jan 2022 21:00:09 -0500 Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 685B4C061761; Mon, 3 Jan 2022 18:00:09 -0800 (PST) Received: by mail-wr1-x431.google.com with SMTP id d9so73120177wrb.0; Mon, 03 Jan 2022 18:00:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=8cBImQisBKAHtvlDQJfX6bglH26IaJinQfqeXp5MNMQ=; b=HXxbijwEe2V6r9bC1wui/7cTUPhTP5bk3OVouq3z0HL1USs0CZipSIFWxiWt+B7G3g yMTkoZax913QcW1DzdCXHUBcY8ngL0DNaXlq95T5hJ3qjS7TJu0QqytLeUAYWgTbRPV9 Sgxf6ORObuKil/4TkNfdk0XUdKBAcwqsNCbOF7IOqocl0fkdguxyVbCQFfXtlys/smG3 0w0jFKhqCrFLerQUSWQpd4uRetQsJ13lBjEJep+PCfgxQDgI/RJ1/Z38eqxNYJ5eviga URUejOQIMRc8UIf5K6967tx06d7A43/w49IYZ4N3jLj5u2zmzwSjvaByBlG5cnWohJLW ijfw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=8cBImQisBKAHtvlDQJfX6bglH26IaJinQfqeXp5MNMQ=; b=lN+hOvWUvgqQfix+FGVNo/ZrYVekhEOUnPZdhDce/UwS4w0gBm6yzyYcDtz7Flxr5B Iiyh5xnkZS3c6Qod+M5e/9uOJpw5qw+lg2fCzO0qQ4/Wsj/nSVymjVMMcvY3xIOk5pc6 mte5kRJ8kRobeN4b8eWSz3jKQbV9AjBpfseGK6zYd1dym7uVeXDrBXGpFLu+EuyAInve IpyEY4CnYHWCVV3PchBNs+yjz3aCfUkkzRAuZBv3jXLoT+BOqW3JwdbmGoFf8zJ+glzt laWjWRwwziSehw0CV92MOlRXg1trlcMDcAnh61EnZDtPXQp4YBYdRWvO+9JK5S2IKQtV Z7Yw== X-Gm-Message-State: AOAM531XXqZARw0Zz7iWw17mjg7S3Ni6w3VrvzLZILUUUfI+lc1PRLg5 agvRvbFRFvEyRQ5q0BtlUyeMY4I3wqxOsA== X-Google-Smtp-Source: ABdhPJyLPnjP8W9Fe/hso4WijGNNx3lpV+7Pr+G4Dlm6HhesJTNZn/ox6KZXvchj1ISKhK0eAZb6JA== X-Received: by 2002:a5d:64e1:: with SMTP id g1mr40578730wri.403.1641261608048; Mon, 03 Jan 2022 18:00:08 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:07 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 10/15] scripts: kernel-doc: Replace the usage function Date: Tue, 4 Jan 2022 02:59:41 +0100 Message-Id: <20220104015946.529524-11-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This ends the fundamental POD transformation. You can see the results with: $ scripts/kernel-doc -help * Transform documentation into POD (10/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 33e7923683a0..b4852c2ba243 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -79,15 +79,6 @@ See Documentation/doc-guide/kernel-doc.rst for the docum= entation comment syntax. # 25/07/2012 - Added support for HTML5 # -- Dan Luedtke =20 -sub usage { - my $message =3D <<"EOF"; -Usage: $0 [OPTION ...] FILE ... - -EOF - print $message; - exit 1; -} - # # format of comments. # In the following table, (...)? signifies optional structure. @@ -468,7 +459,7 @@ while ($ARGV[0] =3D~ m/^--?(.*)/) { } elsif ($cmd eq "Werror") { $Werror =3D 1; } elsif (($cmd eq "h") || ($cmd eq "help")) { - usage(); + pod2usage(-exitval =3D> 0, -verbose =3D> 2); } elsif ($cmd eq 'no-doc-sections') { $no_doc_sections =3D 1; } elsif ($cmd eq 'enable-lineno') { --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 00AE4C433F5 for ; Tue, 4 Jan 2022 02:00:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232499AbiADCAr (ORCPT ); Mon, 3 Jan 2022 21:00:47 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54188 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232222AbiADCAK (ORCPT ); Mon, 3 Jan 2022 21:00:10 -0500 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 395F7C061799; Mon, 3 Jan 2022 18:00:10 -0800 (PST) Received: by mail-wr1-x436.google.com with SMTP id o3so14842633wrh.10; Mon, 03 Jan 2022 18:00:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=PQtuX7PnzQb1a86BihNMH5QlslE8Ui1MxXpx4wzRIaE=; b=hG/CD/zWmn8lRNG7hIMn8AfcNWR5Upf9Ng5erTBZRbGF90VLTTPS5PGrSlR8b17LtS NnIqa3OAB9lJvXISTlEig4a8uqJpsjlDuxxItOMk0xzP7mhsRlYTPDH9/xokqOuCOUvx 7oBgVNTr4gmpA/5WWXnIUANLDg62QYYc8fC96utMrk7vYU0+nCBnCPS9kVlMd5x8lxXe 0pzJmVi23Ax36J4nLjiqpczNzAzrgn91JSjLVAlbwaF6I6VBDmhnvH8C0Ok1l76Tg4hF 41w+0PNgmpFDIRXzrDfKM/rIyz4Gx3SKUIpEHjtyLFkzLkj8U7R1pHO/b2r42VTtB6Ys 3Z9A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=PQtuX7PnzQb1a86BihNMH5QlslE8Ui1MxXpx4wzRIaE=; b=UJOyV/D8pjQqmXOvpJgDCGE02Mkxd87slslpztpvRcNYwIchgDep/MWV5e6Awr1qMG h9fYYspLir2twDKPPnYFT9fkgumF/E8oqwHlAQcCR1g4rSLwdi6GOII3hHtv9EYH74ft Lj+6ae1IbPiGL8UbX0FUWUauSFbZH9WoEN0A5a1bhSGHc72xxM/cyc4pF4BbKvyfdY+3 h3PQ36a5AyuTwqv1Msu7KDs3G7ukrnH5lr8f51Z6AXy3pE3op1LBo3FLVIAio2MuZecq AZVG6drAsIK0r+fEw71BfGoguB1H2iDpCia7ESWSc1u9fveIqIwfnkBb4ALJmm/msZjD o5gQ== X-Gm-Message-State: AOAM530onOW/z1MY+kzIKBkovl1mtS6VEW1bnyTGM1HNSGXrofad9Wsg 3o5Sqph9oRRjRkHRQVOlse8= X-Google-Smtp-Source: ABdhPJz+s6TKmSDF3SORmTjVP+66m//a/ECamkarHGRRSkaNHv2RUlss+V4mITyI0P0eljwvTEFqOA== X-Received: by 2002:a05:6000:1acd:: with SMTP id i13mr40409713wry.406.1641261608888; Mon, 03 Jan 2022 18:00:08 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:08 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Jani Nikula Subject: [PATCH v3 11/15] scripts: kernel-doc: Remove the "format of comments" comment block Date: Tue, 4 Jan 2022 02:59:42 +0100 Message-Id: <20220104015946.529524-12-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org As suggested by Jani Nikula in a reply to my first version of this transformation, Documentation/doc-guide/kernel-doc.rst can serve as the information hub for comment formatting. The section DESCRIPTION already points there, so the original comment block can just be removed. * Transform documentation into POD (11/15) See step 1 for the series details. =3D Meta note =3D I guess, I should use the Suggested-by tag for credits. Maintainers, please correct this if I'm doing this wrong. Suggested-by: Jani Nikula Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 115 --------------------------------------------- 1 file changed, 115 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index b4852c2ba243..493c024744b0 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -79,121 +79,6 @@ See Documentation/doc-guide/kernel-doc.rst for the docu= mentation comment syntax. # 25/07/2012 - Added support for HTML5 # -- Dan Luedtke =20 -# -# format of comments. -# In the following table, (...)? signifies optional structure. -# (...)* signifies 0 or more structure elements -# /** -# * function_name(:)? (- short description)? -# (* @parameterx: (description of parameter x)?)* -# (* a blank line)? -# * (Description:)? (Description of function)? -# * (section header: (section description)? )* -# (*)?*/ -# -# So .. the trivial example would be: -# -# /** -# * my_function -# */ -# -# If the Description: header tag is omitted, then there must be a blank li= ne -# after the last parameter specification. -# e.g. -# /** -# * my_function - does my stuff -# * @my_arg: its mine damnit -# * -# * Does my stuff explained. -# */ -# -# or, could also use: -# /** -# * my_function - does my stuff -# * @my_arg: its mine damnit -# * Description: Does my stuff explained. -# */ -# etc. -# -# Besides functions you can also write documentation for structs, unions, -# enums and typedefs. Instead of the function name you must write the name -# of the declaration; the struct/union/enum/typedef must always precede -# the name. Nesting of declarations is not supported. -# Use the argument mechanism to document members or constants. -# e.g. -# /** -# * struct my_struct - short description -# * @a: first member -# * @b: second member -# * -# * Longer description -# */ -# struct my_struct { -# int a; -# int b; -# /* private: */ -# int c; -# }; -# -# All descriptions can be multiline, except the short function description. -# -# For really longs structs, you can also describe arguments inside the -# body of the struct. -# eg. -# /** -# * struct my_struct - short description -# * @a: first member -# * @b: second member -# * -# * Longer description -# */ -# struct my_struct { -# int a; -# int b; -# /** -# * @c: This is longer description of C -# * -# * You can use paragraphs to describe arguments -# * using this method. -# */ -# int c; -# }; -# -# This should be use only for struct/enum members. -# -# You can also add additional sections. When documenting kernel functions = you -# should document the "Context:" of the function, e.g. whether the functio= ns -# can be called form interrupts. Unlike other sections you can end it with= an -# empty line. -# A non-void function should have a "Return:" section describing the return -# value(s). -# Example-sections should contain the string EXAMPLE so that they are mark= ed -# appropriately in DocBook. -# -# Example: -# /** -# * user_function - function that can only be called in user context -# * @a: some argument -# * Context: !in_interrupt() -# * -# * Some description -# * Example: -# * user_function(22); -# */ -# ... -# -# -# All descriptive text is further processed, scanning for the following sp= ecial -# patterns, which are highlighted appropriately. -# -# 'funcname()' - function -# '$ENVVAR' - environmental variable -# '&struct_name' - name of a structure (up to two words including 'struct') -# '&struct_name.member' - name of a structure member -# '@parameter' - name of a parameter -# '%CONST' - name of a constant. -# '``LITERAL``' - literal string without any spaces on it. - ## init lots of data =20 my $errors =3D 0; --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 26EE6C433F5 for ; Tue, 4 Jan 2022 02:00:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232359AbiADCAg (ORCPT ); Mon, 3 Jan 2022 21:00:36 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54200 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232170AbiADCAL (ORCPT ); Mon, 3 Jan 2022 21:00:11 -0500 Received: from mail-wr1-x42a.google.com (mail-wr1-x42a.google.com [IPv6:2a00:1450:4864:20::42a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2FDE0C0617A0; Mon, 3 Jan 2022 18:00:11 -0800 (PST) Received: by mail-wr1-x42a.google.com with SMTP id o3so14842685wrh.10; Mon, 03 Jan 2022 18:00:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Ar26/c+kIZBFJb+XnQqNFZG/AVeErXaJRatHs0lNH6o=; b=hQnfUOWNahCdKeWzQ+6ERxXar+t2wmfvf12x7AAfzGg+Uudxo3/oScc9J/keEquxCe Y03x44quqPabgOQSlC2vwK660gqVr6Jlmp+DU66bey/n599HTvB/BzbsyeomqUZbSs6w dpOd9j0OLpKd2PmSoKjxzGPr0LK+3Cg8DJLDGEjpLcmhcKAXlDd50Jd9lVfQ5lQq12ml KuolUTF3mNBKKQnNj4PcqSEa9hwNdFS4d3Y1dZ37iRdOWi+1IdYdFtWXaQTL2Jb8H3pI 2he3ppcztMYVhiYIHSyZip4kT+jLi2cZ5DM8zjVZbR+uAl/9k20avTj09B2bE5Vv85L5 PGiA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Ar26/c+kIZBFJb+XnQqNFZG/AVeErXaJRatHs0lNH6o=; b=CJN8yERpwCYSqGMrsEF0Tjx80HeP+qNdKlrC9TGxOZj0k6VWaUX55Lb5ixNQ/Kwpx7 N0v+tJelV1s+7IxNvba4yPBCgVrdmRpYTY5KVyOVmszRo+OgCz06L8/uyCJcAD6lXtoe DWdd+W89vY3+UJs9h4gSpyh3aU39u1xMIS43KA2Vont+c9zOlctnigAugSzcnN/DcCYb 1jztpL0OAf8TbLifYpoq94Suh2C3Vm8fMkg4pt9TKSAf9AcuBu0KThDvViQuhuXc/VRt 3tTpnt/VbDlprSeI26RGuEaJF6iWvMEZy1sqbSy9ECsHwuCx+FHeMsup0y+1u/eY6Ik9 N+FQ== X-Gm-Message-State: AOAM5336797jk3PNuVJLvMnPbK20U1eANmoeb32tja9c9nd1bpeQbrZg VZhJpy5sGMV+o7OlFGV0KFg= X-Google-Smtp-Source: ABdhPJyLl5FmLAj4nJx99t3oXtH8nAHyoSwJLjkxd140QLtb9HwsvoxPzIXit5Sz/TeaqN3iFMVoWA== X-Received: by 2002:a5d:608c:: with SMTP id w12mr39780774wrt.384.1641261609806; Mon, 03 Jan 2022 18:00:09 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:09 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 12/15] scripts: kernel-doc: Archive the pre-git museum Date: Tue, 4 Jan 2022 02:59:43 +0100 Message-Id: <20220104015946.529524-13-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Jonathan Corbet suggested in a reply to my version 1, that these records can go, since that's what the git log is for. I don't agree. The log begins at 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2. That's from 2005. One of those entries is indeed logged, so kudos for having me check this. But not the older ones. Of course they can be found indirectly, but then... Why not just let them embellish the script tail? As you can see, they don't even require any formatting there. Are you sure you don't want them? * Transform documentation into POD (12/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 493c024744b0..0be723f6e3a2 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -54,31 +54,10 @@ See Documentation/doc-guide/kernel-doc.rst for the docu= mentation comment syntax. =20 # more perldoc at the end of the file =20 -# 18/01/2001 - Cleanups -# Functions prototyped as foo(void) same as foo() -# Stop eval'ing where we don't need to. -# -- huggie@earth.li - -# 27/06/2001 - Allowed whitespace after initial "/**" and -# allowed comments before function declarations. -# -- Christian Kreibich - # Still to do: # - add perldoc documentation # - Look more closely at some of the scarier bits :) =20 -# 26/05/2001 - Support for separate source and object trees. -# Return error code. -# Keith Owens - -# 23/09/2001 - Added support for typedefs, structs, enums and unions -# Support for Context section; can be terminated using empty = line -# Small fixes (like spaces vs. \s in regex) -# -- Tim Jansen - -# 25/07/2012 - Added support for HTML5 -# -- Dan Luedtke - ## init lots of data =20 my $errors =3D 0; @@ -2518,3 +2497,25 @@ Treat warnings as errors. =3Dback =20 =3Dcut + +PRE-GIT MUSEUM + +Original formatting preserved for its historical value. + +# 18/01/2001 - Cleanups +# Functions prototyped as foo(void) same as foo() +# Stop eval'ing where we don't need to. +# -- huggie@earth.li + +# 27/06/2001 - Allowed whitespace after initial "/**" and +# allowed comments before function declarations. +# -- Christian Kreibich + +# 26/05/2001 - Support for separate source and object trees. +# Return error code. +# Keith Owens + +# 23/09/2001 - Added support for typedefs, structs, enums and unions +# Support for Context section; can be terminated using empty = line +# Small fixes (like spaces vs. \s in regex) +# -- Tim Jansen --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 694F7C433EF for ; Tue, 4 Jan 2022 02:00:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232447AbiADCAd (ORCPT ); Mon, 3 Jan 2022 21:00:33 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54204 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232174AbiADCAM (ORCPT ); Mon, 3 Jan 2022 21:00:12 -0500 Received: from mail-wr1-x42f.google.com (mail-wr1-x42f.google.com [IPv6:2a00:1450:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F3A27C061761; Mon, 3 Jan 2022 18:00:11 -0800 (PST) Received: by mail-wr1-x42f.google.com with SMTP id s1so73142140wrg.1; Mon, 03 Jan 2022 18:00:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=FKt+68jSJUNCPwwNkf1daEWZcboLbqBRutwCXsKv6BY=; b=UI4sc8btEpIhbSoPM1g2MwogF/i4FelcSbkK+DTrjL19NrhipgomOZahGVpZlwBeJb pItcfr0RI9EGVFuk+kD8+zLY6+e/kYANH9PnnytA7dW1/1gZ8dgHp1uOV35hmgn9BzHu okfpFB3srnmqivpiKmDZHwLV5HXcaFQKqf+eBcvMtgB30FBpf08eGvSqtYKsodQbDZWy alelCrfAakvEXAC4NdZkUYeNdzSyf6wwL1ql46J313gPPFtSGzk9u8ijweBXiOokapCu V2PIRx2t3bkiGcY9JHRQRyp1eaqiUXBZcmbja+rDwpUrLyjUurdsdqVR9y2XngpuBwO+ QmMw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=FKt+68jSJUNCPwwNkf1daEWZcboLbqBRutwCXsKv6BY=; b=TBQi26i70XEF5z8UDzRrVri9QbHDLK5Si8gNhYX0jYJ+hMXzMB0FrxKzjsxSE9jz3c 6MaYKnmyzyMwVUEOsgYU+Yrn+bHi/bWlWfVrV3IRv6LvDDmFd9FCRXjq7Zr3abM7hmEf 65TeNvNic6As5/VXRTHttGLUB7Z21k/J1pqGw7Jdx4OwV8D9jNMTVrNat5buyBLpG7lV 3Rv61ITWjzBHMkeRX0RDFseXrSVjxHvhx+LV8S4ADws1FpwqPkvy+g5r8ctbj4kaPqzM OTvn6YHCDlGEdp6YFFHdiKZRMMzlivwGdTXLfvr87vu/e2CW24MMjUZSLGHFahmOOM6/ wwwQ== X-Gm-Message-State: AOAM530ZZYgfEBzXSYhe/GVVqv4Y8Gnv3ZfUk2CA0WyBo+gJtkJkpzMv C7YlaP2YJMjbrqJOKEYKf/7wtpiBuwbpnw== X-Google-Smtp-Source: ABdhPJyLaTU+gIr+tKJZAQVYKr2HdsiCQWaMs1nmbdo7oiM37vshBWu8HH6tFWqwwwDmsf4qnswMDA== X-Received: by 2002:adf:dcc9:: with SMTP id x9mr39851386wrm.122.1641261610624; Mon, 03 Jan 2022 18:00:10 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:10 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 13/15] scripts: kernel-doc: License cleanup Date: Tue, 4 Jan 2022 02:59:44 +0100 Message-Id: <20220104015946.529524-14-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org As stated by Jonathan Corbet in the reply to my version 1, the SPDX line is enough. * Transform documentation into POD (13/15) See step 1 for the series details. (Still not sure about this tag line, so please correct if needed.) Suggested-by: Jonathan Corbet Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 3 --- 1 file changed, 3 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 0be723f6e3a2..e4de593dbcb7 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -12,9 +12,6 @@ use strict; ## ## ## #define enhancements by Armin Kuster ## ## Copyright (c) 2000 MontaVista Software, Inc. ## -## ## -## This software falls under the GNU General Public License. ## -## Please read the COPYING file for more information ## =20 use Pod::Usage qw/pod2usage/; =20 --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D0CB1C433EF for ; Tue, 4 Jan 2022 02:00:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232385AbiADCAk (ORCPT ); Mon, 3 Jan 2022 21:00:40 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54214 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232263AbiADCAN (ORCPT ); Mon, 3 Jan 2022 21:00:13 -0500 Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 13BA1C061785; Mon, 3 Jan 2022 18:00:13 -0800 (PST) Received: by mail-wr1-x429.google.com with SMTP id v6so11318308wra.8; Mon, 03 Jan 2022 18:00:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=88NWVxoXqyug+IDUMWZAyItnBanJj1QoR3rF3JESF/M=; b=BkN2LIaXhLNIXriMIqJhAfPKR+kLuNNywIOKmi2YdnBtrN7WLSM6ujDLhGCGe65lQn iuZhp3Mj1IQSJADj1nlGcdTmoVAdKof/rmkF7SE+KymeUBeit5BZtoGCiCEUX7PPzjgt Qyp4tOllBoIfvA1PV4JkVudp+0yp7F14QTWrnt45xFOXUp54XTnh16DZlmkxS0aLB45h f0rsyYkdXrP4SzdFrEun2uFuUjntksSpjI9WbP/BGIrK76C/G6YzLCWvxHf/UHMBGUZV bF5cV6GpUzusMNYXqg0i4rwAgkYuCI8AFh8PfH8tj7zxddsTlRj849F7e2SmohclNsr+ 2WRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=88NWVxoXqyug+IDUMWZAyItnBanJj1QoR3rF3JESF/M=; b=IN1F+EhrqbjmF3RUJV/RElAlKtd/+Vd1b28A12dAgewJgpGpbsoR3jAQQH50cbAUiB v4dlVgb4IFMYwo9M95yX0NFoKWIb8L0wTdOxC/br/rXs8w8Ctb0EVQ1NEboi46jZMMAB a8otOU8PCp5PT1p31SAaTDPO2FH+2+qhe/QVkowFdr2gpvw5wJ9TkaTHIqNLKeWTwLlO wVNLlAxre9Bp8IX7QBSnf52dvRHohRtlOmSjCv7bz5Ho7oDtREOP94/2AwqfhJz4m6Eg eU/ZRgMKryHmeslmNwY1ncQita8mYz3u0mW8ISAEOay8qNUmEW1Hejl6IDqLBBj86wu+ PHgQ== X-Gm-Message-State: AOAM533UO74zrEBdg2v17Y1gsW7o+BoZLcWV3nVmHsVkz2F5iEew1ifj rek0YQApJPPg67NngQ5LsvM= X-Google-Smtp-Source: ABdhPJy8K0NsmRGuNIRtv+7ls0n2bKRuBIJTYKZlBW2zjTWvHKlCy0zapkGURk3oK7arfq6K34DcyQ== X-Received: by 2002:a05:6000:104f:: with SMTP id c15mr40104006wrx.665.1641261611748; Mon, 03 Jan 2022 18:00:11 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:11 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 14/15] scripts: kernel-doc: Refresh the copyright lines Date: Tue, 4 Jan 2022 02:59:45 +0100 Message-Id: <20220104015946.529524-15-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org I'm not sure, why these notices need to stay at the top, but that's what Jonathat Corbet replied to my version 1. Anyways, I've cleaned them up a little. Looks good? My name's included as the refreshing force of this venerable script. * Transform documentation into POD (14/15) See step 1 for the series details. (Still not sure about this tag line, so please correct, let me know, etc.) Suggested-by: Jonathan Corbet Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index e4de593dbcb7..dd5801cad519 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -4,14 +4,16 @@ use warnings; use strict; =20 -## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## -## Copyright (C) 2000, 1 Tim Waugh ## -## Copyright (C) 2001 Simon Huggins ## -## Copyright (C) 2005-2012 Randy Dunlap ## -## Copyright (C) 2012 Dan Luedtke ## -## ## -## #define enhancements by Armin Kuster ## -## Copyright (c) 2000 MontaVista Software, Inc. ## +# Copyright (C) 1998 Michael Zucchi, All Rights Reserved +# Copyright (C) 2000, 1 Tim Waugh +# Copyright (C) 2001 Simon Huggins +# Copyright (C) 2005-2012 Randy Dunlap +# Copyright (C) 2012 Dan Luedtke +# +# #define enhancements by Armin Kuster +# Copyright (C) 2000 MontaVista Software, Inc. +# +# Copyright (C) 2022 Tomasz Warnie=C5=82=C5=82o (POD) =20 use Pod::Usage qw/pod2usage/; =20 --=20 2.30.2 From nobody Wed Jul 1 03:07:32 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 759C9C433EF for ; Tue, 4 Jan 2022 02:00:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232403AbiADCAn (ORCPT ); Mon, 3 Jan 2022 21:00:43 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54218 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232271AbiADCAO (ORCPT ); Mon, 3 Jan 2022 21:00:14 -0500 Received: from mail-wr1-x430.google.com (mail-wr1-x430.google.com [IPv6:2a00:1450:4864:20::430]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C7E3BC0617A1; Mon, 3 Jan 2022 18:00:13 -0800 (PST) Received: by mail-wr1-x430.google.com with SMTP id j18so73041146wrd.2; Mon, 03 Jan 2022 18:00:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=DuzntP1U4quOJkZ2JAisD9olh8sECglpZxZHObJrdk4=; b=CoyAtFh/CfpNkb/WGr+Cz7UFFKBs3s7vP+gw9aFnHOHfnN4/M4ikIz4DxRvVTiE6Qz +baMdqreWcnunMqIyD2qZZ+UpgbOWvBEn77kcJk3UWrJj4mpoRy/D+rn5kW/lu51dDrY 4bYFCtW90IWDuMQf7sMb5orIlw82t1/q8JqKViBirKEg7+Isu30dIA2JTZ4lsI50NxtM WdWmva7+64PHy800Pd7xRtoRPKN5MBKBMbzCx4kRpIvoV1UEm0Sz4/uUgNaDGDuAoJe0 WMMFHL9BcBjoEAg1qrtpNFyHBVvbNf5ZY8wG9Jf1zJTfF44TzZ0TxQ3PUQeX4xgszN1o MVAw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=DuzntP1U4quOJkZ2JAisD9olh8sECglpZxZHObJrdk4=; b=au6AEajUqIZS7PpZTbKbN+eqd8TMm9AVS9WgVW5KtgYbJr0tNd40OAw9pz3gpNk0vO dEl6nTwG/kSXu3IdQWDMFYeKqu2a8ij39bE75i8hUaNSIVXt6Iq6Yj/Zh8sOm3gFKeCI kxdZIyttUxGjzyzDjMMfECwYpVw+x3D0EbBUpGVnopmYAFYPQ1ujRFFtQ3KgpSfDWSnX dQVyzDY3QAjhE2RkSLjX26UaiWwVlr0UkQCrXWJ7CsZRkpFqtBXZ6DI2Q0KQ5x14jVXF B02Zb2lAizsZehK94z21E6vRjBidtp2VYIT/pe3YMYZ5Y53VAJfNmSM3MLo2SaAecjFT deJw== X-Gm-Message-State: AOAM532pcaYTP4IwP0GGNLO90XGGAgxZr4MJvm6cI7XIY+KKdO+4+qrR ojMH7ImxXQ4i5XjHv37NJ8g= X-Google-Smtp-Source: ABdhPJzHkgYYeXEL3k+bw6r/5h/pLBwAw7ryZHVIgaHqjgAozpXHYqt4eDy3SVoqLzTGwkOKSjsBiA== X-Received: by 2002:a05:6000:1866:: with SMTP id d6mr39642223wri.704.1641261612494; Mon, 03 Jan 2022 18:00:12 -0800 (PST) Received: from fuji.fritz.box (ip-89-161-76-237.tel.tkb.net.pl. [89.161.76.237]) by smtp.gmail.com with ESMTPSA id j17sm36422654wrp.68.2022.01.03.18.00.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 03 Jan 2022 18:00:12 -0800 (PST) From: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= To: corbet@lwn.net Cc: =?UTF-8?q?Tomasz=20Warnie=C5=82=C5=82o?= , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 15/15] scripts: kernel-doc: Move the TODOs Date: Tue, 4 Jan 2022 02:59:46 +0100 Message-Id: <20220104015946.529524-16-tomasz.warniello@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com> References: <20220104015946.529524-1-tomasz.warniello@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Earlier I thought I could take "add perldoc documentation" off of this list. Now I think it also means a self-documentation. And this is not even started. I'm putting this block by the end, where it can quietly evolve. * Transform documentation into POD (15/15) See step 1 for the series details. Signed-off-by: Tomasz Warnie=C5=82=C5=82o --- scripts/kernel-doc | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index dd5801cad519..b9f381f0fc1b 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -53,10 +53,6 @@ See Documentation/doc-guide/kernel-doc.rst for the docum= entation comment syntax. =20 # more perldoc at the end of the file =20 -# Still to do: -# - add perldoc documentation -# - Look more closely at some of the scarier bits :) - ## init lots of data =20 my $errors =3D 0; @@ -2497,6 +2493,11 @@ Treat warnings as errors. =20 =3Dcut =20 +TODO + +- add perldoc documentation +- Look more closely at some of the scarier bits :) + PRE-GIT MUSEUM =20 Original formatting preserved for its historical value. --=20 2.30.2