[PATCH 0/1] docs: watchdog: make htmldocs failed.

[PATCH 0/1] docs: watchdog: make htmldocs failed.

[Jerry Hoemann]

Guenter,

While making htmldocs from linux-staging.git watchdog-next, the
build failed due what I think is a missing blank line after a header
separator in:

	Documentation/watchdog/watchdog-parameters.rst

I'm a newbie w.r.t. to the .rst file formats, but adding the blank
lines got the "make htmldocs" to complete.






Jerry Hoemann (1):
  docs: watchdog: Fix build error.

 Documentation/watchdog/watchdog-parameters.rst | 2 ++
 1 file changed, 2 insertions(+)

-- 
2.20.1

[PATCH 1/1] docs: watchdog: Fix build error.

[Jerry Hoemann]

make htmldocs fails due to missing blank line following header.

Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com>
---
 Documentation/watchdog/watchdog-parameters.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/watchdog/watchdog-parameters.rst b/Documentation/watchdog/watchdog-parameters.rst
index 01023382ea73..a3985cc5aeda 100644
--- a/Documentation/watchdog/watchdog-parameters.rst
+++ b/Documentation/watchdog/watchdog-parameters.rst
@@ -12,6 +12,7 @@ providing kernel parameters for builtin drivers versus loadable
 modules.
 
 -------------------------------------------------
+
 watchdog core:
     open_timeout:
 	Maximum time, in seconds, for which the watchdog framework will take
@@ -22,6 +23,7 @@ watchdog core:
 	fallback logic in the bootloader to try something else.
 
 -------------------------------------------------
+
 acquirewdt:
     wdt_stop:
 	Acquire WDT 'stop' io port (default 0x43)
-- 
2.20.1

Re: [PATCH 1/1] docs: watchdog: Fix build error.

[Guenter Roeck]

On Wed, Jun 12, 2019 at 06:02:37PM -0600, Jerry Hoemann wrote:
> make htmldocs fails due to missing blank line following header.
> 
> Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> ---
>  Documentation/watchdog/watchdog-parameters.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/watchdog/watchdog-parameters.rst b/Documentation/watchdog/watchdog-parameters.rst
> index 01023382ea73..a3985cc5aeda 100644
> --- a/Documentation/watchdog/watchdog-parameters.rst
> +++ b/Documentation/watchdog/watchdog-parameters.rst
> @@ -12,6 +12,7 @@ providing kernel parameters for builtin drivers versus loadable
>  modules.
>  
>  -------------------------------------------------
> +
>  watchdog core:
>      open_timeout:
>  	Maximum time, in seconds, for which the watchdog framework will take
> @@ -22,6 +23,7 @@ watchdog core:
>  	fallback logic in the bootloader to try something else.
>  
>  -------------------------------------------------
> +
>  acquirewdt:
>      wdt_stop:
>  	Acquire WDT 'stop' io port (default 0x43)
> -- 
> 2.20.1
> 

Re: [PATCH 1/1] docs: watchdog: Fix build error.

[Mauro Carvalho Chehab]

Em Wed, 12 Jun 2019 18:02:37 -0600
Jerry Hoemann <jerry.hoemann@hpe.com> escreveu:

> make htmldocs fails due to missing blank line following header.
> 
> Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

> ---
>  Documentation/watchdog/watchdog-parameters.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/watchdog/watchdog-parameters.rst b/Documentation/watchdog/watchdog-parameters.rst
> index 01023382ea73..a3985cc5aeda 100644
> --- a/Documentation/watchdog/watchdog-parameters.rst
> +++ b/Documentation/watchdog/watchdog-parameters.rst
> @@ -12,6 +12,7 @@ providing kernel parameters for builtin drivers versus loadable
>  modules.
>  
>  -------------------------------------------------
> +
>  watchdog core:
>      open_timeout:
>  	Maximum time, in seconds, for which the watchdog framework will take
> @@ -22,6 +23,7 @@ watchdog core:
>  	fallback logic in the bootloader to try something else.
>  
>  -------------------------------------------------
> +
>  acquirewdt:
>      wdt_stop:
>  	Acquire WDT 'stop' io port (default 0x43)



Thanks,
Mauro

Re: [PATCH 0/1] docs: watchdog: make htmldocs failed.

[Mauro Carvalho Chehab]

Em Wed, 12 Jun 2019 18:02:36 -0600
Jerry Hoemann <jerry.hoemann@hpe.com> escreveu:

> Guenter,
> 
> While making htmldocs from linux-staging.git watchdog-next, the
> build failed due what I think is a missing blank line after a header
> separator in:
> 
> 	Documentation/watchdog/watchdog-parameters.rst
> 
> I'm a newbie w.r.t. to the .rst file formats, but adding the blank
> lines got the "make htmldocs" to complete.

Yeah, Sphinx doesn't like to see things like:

------------
foo

as it will miss-interpret the <hr> tag. That usually cause a
severe error the parser, breaking the entire build.

> 
> 
> 
> 
> 
> 
> Jerry Hoemann (1):
>   docs: watchdog: Fix build error.
> 
>  Documentation/watchdog/watchdog-parameters.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 



Thanks,
Mauro