[PATCH 0/2] Documentation/Watchdog/hpwdt

[PATCH 0/2] Documentation/Watchdog/hpwdt

[Jerry Hoemann]

Two small documentation fixes.

First: Fix reference to documentation that moved.
Second: Update List formatting.



Jerry Hoemann (2):
  Documentation/watchdog/hpwdt: Fix Reference
  Documentation/watchdog/hpwdt: Fix Format

 Documentation/watchdog/hpwdt.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

-- 
2.39.1

[PATCH 1/2] Documentation/watchdog/hpwdt: Fix Reference

[Jerry Hoemann]

The IPMI documentation moved to Documentation/driver-api/ipmi.rst.
Update reference to reflect new location.

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

diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
index c824cd7f6e32..c972fc2a3d0b 100644
--- a/Documentation/watchdog/hpwdt.rst
+++ b/Documentation/watchdog/hpwdt.rst
@@ -48,7 +48,7 @@ Last reviewed: 08/20/2018
  NOTE:
        More information about watchdog drivers in general, including the ioctl
        interface to /dev/watchdog can be found in
-       Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.txt.
+       Documentation/watchdog/watchdog-api.rst and Documentation/driver-api/ipmi.rst
 
  Due to limitations in the iLO hardware, the NMI pretimeout if enabled,
  can only be set to 9 seconds.  Attempts to set pretimeout to other
-- 
2.39.1

Re: [PATCH 1/2] Documentation/watchdog/hpwdt: Fix Reference

[Guenter Roeck]

On Fri, Feb 10, 2023 at 11:42:46AM -0700, Jerry Hoemann wrote:
> The IPMI documentation moved to Documentation/driver-api/ipmi.rst.
> Update reference to reflect new location.
> 
> Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com>

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

> ---
>  Documentation/watchdog/hpwdt.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
> index c824cd7f6e32..c972fc2a3d0b 100644
> --- a/Documentation/watchdog/hpwdt.rst
> +++ b/Documentation/watchdog/hpwdt.rst
> @@ -48,7 +48,7 @@ Last reviewed: 08/20/2018
>   NOTE:
>         More information about watchdog drivers in general, including the ioctl
>         interface to /dev/watchdog can be found in
> -       Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.txt.
> +       Documentation/watchdog/watchdog-api.rst and Documentation/driver-api/ipmi.rst
>  
>   Due to limitations in the iLO hardware, the NMI pretimeout if enabled,
>   can only be set to 9 seconds.  Attempts to set pretimeout to other
> -- 
> 2.39.1
> 

[PATCH 2/2] Documentation/watchdog/hpwdt: Fix Format

[Jerry Hoemann]

Add list format so that compiled documentation looks like it was
intended to.

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

diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
index c972fc2a3d0b..5eab5dfec042 100644
--- a/Documentation/watchdog/hpwdt.rst
+++ b/Documentation/watchdog/hpwdt.rst
@@ -63,9 +63,9 @@ Last reviewed: 08/20/2018
  and loop forever.  This is generally not what a watchdog user wants.
 
  For those wishing to learn more please see:
-	Documentation/admin-guide/kdump/kdump.rst
-	Documentation/admin-guide/kernel-parameters.txt (panic=)
-	Your Linux Distribution specific documentation.
+	- Documentation/admin-guide/kdump/kdump.rst
+	- Documentation/admin-guide/kernel-parameters.txt (panic=)
+	- Your Linux Distribution specific documentation.
 
  If the hpwdt does not receive the NMI associated with an expiring timer,
  the iLO will proceed to reset the system at timeout if the timer hasn't
-- 
2.39.1

Re: [PATCH 2/2] Documentation/watchdog/hpwdt: Fix Format

[Guenter Roeck]

On Fri, Feb 10, 2023 at 11:42:47AM -0700, Jerry Hoemann wrote:
> Add list format so that compiled documentation looks like it was
> intended to.
> 
> Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com>

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

> ---
>  Documentation/watchdog/hpwdt.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
> index c972fc2a3d0b..5eab5dfec042 100644
> --- a/Documentation/watchdog/hpwdt.rst
> +++ b/Documentation/watchdog/hpwdt.rst
> @@ -63,9 +63,9 @@ Last reviewed: 08/20/2018
>   and loop forever.  This is generally not what a watchdog user wants.
>  
>   For those wishing to learn more please see:
> -	Documentation/admin-guide/kdump/kdump.rst
> -	Documentation/admin-guide/kernel-parameters.txt (panic=)
> -	Your Linux Distribution specific documentation.
> +	- Documentation/admin-guide/kdump/kdump.rst
> +	- Documentation/admin-guide/kernel-parameters.txt (panic=)
> +	- Your Linux Distribution specific documentation.
>  
>   If the hpwdt does not receive the NMI associated with an expiring timer,
>   the iLO will proceed to reset the system at timeout if the timer hasn't
> -- 
> 2.39.1
> 

Re: [PATCH 0/2] Documentation/Watchdog/hpwdt

[Jonathan Corbet]

Jerry Hoemann <jerry.hoemann@hpe.com> writes:

> Two small documentation fixes.
>
> First: Fix reference to documentation that moved.
> Second: Update List formatting.
>
>
>
> Jerry Hoemann (2):
>   Documentation/watchdog/hpwdt: Fix Reference
>   Documentation/watchdog/hpwdt: Fix Format
>
>  Documentation/watchdog/hpwdt.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon