Re: [PATCH v3 15/15] scripts: kernel-doc: Move the TODOs

From: Jonathan Corbet
Date: Wed Feb 16 2022 - 18:35:03 EST


Tomasz Warniełło <tomasz.warniello@xxxxxxxxx> 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@xxxxxxxxx>
> ---
> 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