linux-kernel - Re: [PATCH 1/1] Added double colons and blank lines within kerneldoc to format code snippets as ReST literal blocks.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200311133027.2c77f348@lwn.net>
Date:   Wed, 11 Mar 2020 13:30:27 -0600
From:   Jonathan Corbet <corbet@....net>
To:     peter@...eshed.quignogs.org.uk
Cc:     linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael@...nel.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH 1/1] Added double colons and blank lines within
 kerneldoc to format code snippets as ReST literal blocks.

On Wed, 11 Mar 2020 19:22:56 +0000
peter@...eshed.quignogs.org.uk wrote:

> From: Peter Lister <peter@...eshed.quignogs.org.uk>
> 
> This removes the following warnings from the kernel doc build...
> ./drivers/base/platform.c:134: WARNING: Unexpected indentation.
> ./drivers/base/platform.c:213: WARNING: Unexpected indentation.
> 
> Signed-off-by: Peter Lister <peter@...eshed.quignogs.org.uk>
> ---
>  drivers/base/platform.c | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/base/platform.c b/drivers/base/platform.c
> index 7fa654f1288b..7fb5cf847253 100644
> --- a/drivers/base/platform.c
> +++ b/drivers/base/platform.c
> @@ -128,7 +128,8 @@ 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: ::
> + *

The change seems good, but you can make it just:

 * Example::

...and keep it a bit more readable.

Thanks,

jon