Linux-Watchdog Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 0/1] docs: watchdog: make htmldocs failed.
@ 2019-06-13  0:02 Jerry Hoemann
  2019-06-13  0:02 ` [PATCH 1/1] docs: watchdog: Fix build error Jerry Hoemann
  2019-06-13  9:57 ` [PATCH 0/1] docs: watchdog: make htmldocs failed Mauro Carvalho Chehab
  0 siblings, 2 replies; 5+ messages in thread
From: Jerry Hoemann @ 2019-06-13  0:02 UTC (permalink / raw)
  To: linux; +Cc: wim, mchehab+samsung, linux-watchdog, linux-kernel, 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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH 1/1] docs: watchdog: Fix build error.
  2019-06-13  0:02 [PATCH 0/1] docs: watchdog: make htmldocs failed Jerry Hoemann
@ 2019-06-13  0:02 ` Jerry Hoemann
  2019-06-13  0:27   ` Guenter Roeck
  2019-06-13  9:53   ` Mauro Carvalho Chehab
  2019-06-13  9:57 ` [PATCH 0/1] docs: watchdog: make htmldocs failed Mauro Carvalho Chehab
  1 sibling, 2 replies; 5+ messages in thread
From: Jerry Hoemann @ 2019-06-13  0:02 UTC (permalink / raw)
  To: linux; +Cc: wim, mchehab+samsung, linux-watchdog, linux-kernel, 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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/1] docs: watchdog: Fix build error.
  2019-06-13  0:02 ` [PATCH 1/1] docs: watchdog: Fix build error Jerry Hoemann
@ 2019-06-13  0:27   ` Guenter Roeck
  2019-06-13  9:53   ` Mauro Carvalho Chehab
  1 sibling, 0 replies; 5+ messages in thread
From: Guenter Roeck @ 2019-06-13  0:27 UTC (permalink / raw)
  To: Jerry Hoemann; +Cc: wim, mchehab+samsung, linux-watchdog, linux-kernel

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
> 

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/1] docs: watchdog: Fix build error.
  2019-06-13  0:02 ` [PATCH 1/1] docs: watchdog: Fix build error Jerry Hoemann
  2019-06-13  0:27   ` Guenter Roeck
@ 2019-06-13  9:53   ` Mauro Carvalho Chehab
  1 sibling, 0 replies; 5+ messages in thread
From: Mauro Carvalho Chehab @ 2019-06-13  9:53 UTC (permalink / raw)
  To: Jerry Hoemann; +Cc: linux, wim, linux-watchdog, linux-kernel

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 0/1] docs: watchdog: make htmldocs failed.
  2019-06-13  0:02 [PATCH 0/1] docs: watchdog: make htmldocs failed Jerry Hoemann
  2019-06-13  0:02 ` [PATCH 1/1] docs: watchdog: Fix build error Jerry Hoemann
@ 2019-06-13  9:57 ` Mauro Carvalho Chehab
  1 sibling, 0 replies; 5+ messages in thread
From: Mauro Carvalho Chehab @ 2019-06-13  9:57 UTC (permalink / raw)
  To: Jerry Hoemann; +Cc: linux, wim, linux-watchdog, linux-kernel

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, back to index

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-06-13  0:02 [PATCH 0/1] docs: watchdog: make htmldocs failed Jerry Hoemann
2019-06-13  0:02 ` [PATCH 1/1] docs: watchdog: Fix build error Jerry Hoemann
2019-06-13  0:27   ` Guenter Roeck
2019-06-13  9:53   ` Mauro Carvalho Chehab
2019-06-13  9:57 ` [PATCH 0/1] docs: watchdog: make htmldocs failed Mauro Carvalho Chehab

Linux-Watchdog Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-watchdog/0 linux-watchdog/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-watchdog linux-watchdog/ https://lore.kernel.org/linux-watchdog \
		linux-watchdog@vger.kernel.org linux-watchdog@archiver.kernel.org
	public-inbox-index linux-watchdog


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-watchdog


AGPL code for this site: git clone https://public-inbox.org/ public-inbox