lkml.org 
[lkml]   [2020]   [Mar]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [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@bikeshed.quignogs.org.uk wrote:

> From: Peter Lister <peter@bikeshed.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@bikeshed.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
\
 
 \ /
  Last update: 2020-03-11 20:30    [W:0.072 / U:9.564 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site