[PATCH] Documentation: bootconfig: fix Sphinx block warning

[PATCH] Documentation: bootconfig: fix Sphinx block warning

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix Sphinx format warning:

lnx-56-rc1/Documentation/admin-guide/bootconfig.rst:26: WARNING: Literal block expected; none found.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Masami Hiramatsu <mhiramat@kernel.org>
---
 Documentation/admin-guide/bootconfig.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- lnx-56-rc1.orig/Documentation/admin-guide/bootconfig.rst
+++ lnx-56-rc1/Documentation/admin-guide/bootconfig.rst
@@ -23,7 +23,7 @@ of dot-connected-words, and key and valu
 has to be terminated by semi-colon (``;``) or newline (``\n``).
 For array value, array entries are separated by comma (``,``). ::
 
-KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
+  KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
 
 Unlike the kernel command line syntax, spaces are OK around the comma and ``=``.
 

Re: [PATCH] Documentation: bootconfig: fix Sphinx block warning

[Masami Hiramatsu]

On Sun, 9 Feb 2020 19:53:17 -0800
Randy Dunlap <rdunlap@infradead.org> wrote:

> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix Sphinx format warning:
> 
> lnx-56-rc1/Documentation/admin-guide/bootconfig.rst:26: WARNING: Literal block expected; none found.
> 

Good catch!

Acked-by: Masami Hiramatsu <mhiramat@kernel.org>

Thanks for the fix!

> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Steven Rostedt <rostedt@goodmis.org>
> Cc: Masami Hiramatsu <mhiramat@kernel.org>
> ---
>  Documentation/admin-guide/bootconfig.rst |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-56-rc1.orig/Documentation/admin-guide/bootconfig.rst
> +++ lnx-56-rc1/Documentation/admin-guide/bootconfig.rst
> @@ -23,7 +23,7 @@ of dot-connected-words, and key and valu
>  has to be terminated by semi-colon (``;``) or newline (``\n``).
>  For array value, array entries are separated by comma (``,``). ::
>  
> -KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
> +  KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
>  
>  Unlike the kernel command line syntax, spaces are OK around the comma and ``=``.
>  
> 


-- 
Masami Hiramatsu <mhiramat@kernel.org>

Re: [PATCH] Documentation: bootconfig: fix Sphinx block warning

[Steven Rostedt]

Jon,

Would you like to take this through your tree?

  https://lore.kernel.org/r/07b3e31f-9b1e-1876-aa60-4436e4dd6da0@infradead.org

-- Steve



On Mon, 10 Feb 2020 16:16:47 +0900
Masami Hiramatsu <mhiramat@kernel.org> wrote:

> On Sun, 9 Feb 2020 19:53:17 -0800
> Randy Dunlap <rdunlap@infradead.org> wrote:
> 
> > From: Randy Dunlap <rdunlap@infradead.org>
> > 
> > Fix Sphinx format warning:
> > 
> > lnx-56-rc1/Documentation/admin-guide/bootconfig.rst:26: WARNING: Literal block expected; none found.
> >   
> 
> Good catch!
> 
> Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
> 
> Thanks for the fix!
> 
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > Cc: Steven Rostedt <rostedt@goodmis.org>
> > Cc: Masami Hiramatsu <mhiramat@kernel.org>
> > ---
> >  Documentation/admin-guide/bootconfig.rst |    2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > --- lnx-56-rc1.orig/Documentation/admin-guide/bootconfig.rst
> > +++ lnx-56-rc1/Documentation/admin-guide/bootconfig.rst
> > @@ -23,7 +23,7 @@ of dot-connected-words, and key and valu
> >  has to be terminated by semi-colon (``;``) or newline (``\n``).
> >  For array value, array entries are separated by comma (``,``). ::
> >  
> > -KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
> > +  KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
> >  
> >  Unlike the kernel command line syntax, spaces are OK around the comma and ``=``.
> >  
> >   
> 
> 

Re: [PATCH] Documentation: bootconfig: fix Sphinx block warning

[Jonathan Corbet]

On Mon, 10 Feb 2020 11:54:10 -0500
Steven Rostedt <rostedt@goodmis.org> wrote:

> Jon,
> 
> Would you like to take this through your tree?
> 
>   https://lore.kernel.org/r/07b3e31f-9b1e-1876-aa60-4436e4dd6da0@infradead.org

Will do.

jon