linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: "Tomasz Warniełło" <tomasz.warniello@gmail.com>
Cc: "Tomasz Warniełło" <tomasz.warniello@gmail.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 15/15] scripts: kernel-doc: Move the TODOs
Date: Wed, 16 Feb 2022 16:34:55 -0700	[thread overview]
Message-ID: <877d9u2xnk.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220104015946.529524-16-tomasz.warniello@gmail.com>

Tomasz Warniełło <tomasz.warniello@gmail.com> writes:

> 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łło <tomasz.warniello@gmail.com>
> ---
>  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 documentation comment syntax.
>  
>  # more perldoc at the end of the file
>  
> -# Still to do:
> -# 	- add perldoc documentation
> -# 	- Look more closely at some of the scarier bits :)
> -
>  ## init lots of data
>  
>  my $errors = 0;
> @@ -2497,6 +2493,11 @@ Treat warnings as errors.
>  
>  =cut
>  
> +TODO
> +
> +- add perldoc documentation
> +- Look more closely at some of the scarier bits :)
> +

I'm not convinced that there's any value in this bit of text, I'd just
take it out.

Thanks,

jon

  reply	other threads:[~2022-02-16 23:34 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-04  1:59 [PATCH v3 00/15] Transform documentation into POD Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 01/15] scripts: kernel-doc: Add the NAME section Tomasz Warniełło
2022-02-16 23:18   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 02/15] scripts: kernel-doc: Add the SYNOPSIS section Tomasz Warniełło
2022-02-16 23:19   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 03/15] scripts: kernel-doc: Relink argument parsing error handling to pod2usage Tomasz Warniełło
2022-02-16 23:21   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 04/15] scripts: kernel-doc: Translate the DESCRIPTION section Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 05/15] scripts: kernel-doc: Translate the "Output format selection" subsection of OPTIONS Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 06/15] scripts: kernel-doc: Translate the "Output format selection modifier" " Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 07/15] scripts: kernel-doc: Translate the "Output selection" " Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 08/15] scripts: kernel-doc: Translate the "Output selection modifiers" " Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 09/15] scripts: kernel-doc: Translate the "Other parameters" " Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 10/15] scripts: kernel-doc: Replace the usage function Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 11/15] scripts: kernel-doc: Remove the "format of comments" comment block Tomasz Warniełło
2022-02-16 23:26   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 12/15] scripts: kernel-doc: Archive the pre-git museum Tomasz Warniełło
2022-02-16 23:29   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 13/15] scripts: kernel-doc: License cleanup Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 14/15] scripts: kernel-doc: Refresh the copyright lines Tomasz Warniełło
2022-02-16 23:34   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 15/15] scripts: kernel-doc: Move the TODOs Tomasz Warniełło
2022-02-16 23:34   ` Jonathan Corbet [this message]
2022-01-13  6:41 ` [PATCH v3 00/15] Transform documentation into POD Tomasz Warniełło
2022-01-13 16:19   ` Jonathan Corbet
2022-02-16 23:14 ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=877d9u2xnk.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=tomasz.warniello@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).