[PATCH v2] docs: core-api: Documentation build warning fix

[PATCH v2] docs: core-api: Documentation build warning fix

[Yanteng Si]

commit 821c734b5b07 ("module: add printk formats to add module build ID to stacktraces")
Causes the following warning:
Documentation/core-api/printk-formats.rst:137: WARNING: Unexpected indentation.
Documentation/core-api/printk-formats.rst:138: WARNING: Block quote ends without a blank line; unexpected unindent.

So, add a blank line to the end of "::".

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
---
v2:
* use the canonical format for referring to other commits
* pick Stephen's Reviewed-by tag

 Documentation/core-api/printk-formats.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index a68730e7cfac..38ec2b05e54f 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -131,6 +131,7 @@ printed after the symbol name with an extra ``b`` appended to the end of the
 specifier.
 
 ::
+
 	%pS	versatile_init+0x0/0x110 [module_name]
 	%pSb	versatile_init+0x0/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
 	%pSRb	versatile_init+0x9/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
-- 
2.27.0

Re: [PATCH v2] docs: core-api: Documentation build warning fix

[Andy Shevchenko]

On Fri, May 28, 2021 at 06:00:16PM +0800, Yanteng Si wrote:
> commit 821c734b5b07 ("module: add printk formats to add module build ID to stacktraces")
> Causes the following warning:

> Documentation/core-api/printk-formats.rst:137: WARNING: Unexpected indentation.
> Documentation/core-api/printk-formats.rst:138: WARNING: Block quote ends without a blank line; unexpected unindent.

The Documentation/core-api/ part can be dropped in both lines.
Anyway, makes sense to me, thanks for fixing it.

> So, add a blank line to the end of "::".

Acked-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
> Reviewed-by: Stephen Boyd <swboyd@chromium.org>
> ---
> v2:
> * use the canonical format for referring to other commits
> * pick Stephen's Reviewed-by tag
> 
>  Documentation/core-api/printk-formats.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
> index a68730e7cfac..38ec2b05e54f 100644
> --- a/Documentation/core-api/printk-formats.rst
> +++ b/Documentation/core-api/printk-formats.rst
> @@ -131,6 +131,7 @@ printed after the symbol name with an extra ``b`` appended to the end of the
>  specifier.
>  
>  ::
> +
>  	%pS	versatile_init+0x0/0x110 [module_name]
>  	%pSb	versatile_init+0x0/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
>  	%pSRb	versatile_init+0x9/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
> -- 
> 2.27.0
> 

-- 
With Best Regards,
Andy Shevchenko