diff mbox series

[ndctl] cxl/documentation: tidy up cxl-wait-sanitize man page format

Message ID 20240229212838.2006205-1-alison.schofield@intel.com (mailing list archive)
State Accepted
Commit a37665ad3f0024b6364e8f90d0804ecc0716ba85
Headers show
Series [ndctl] cxl/documentation: tidy up cxl-wait-sanitize man page format | expand

Commit Message

Alison Schofield Feb. 29, 2024, 9:28 p.m. UTC
From: Alison Schofield <alison.schofield@intel.com>

Remove extra '==' to address these asciidoctor complaints:

Generating Documentation/cxl/cxl-wait-sanitize with a custom command
ERROR: cxl-wait-sanitize.txt: line 1: non-conforming manpage title
ERROR: cxl-wait-sanitize.txt: line 3: name section expected
WARNING: cxl-wait-sanitize.txt: line 4: unterminated example block
WARNING: cxl-wait-sanitize.txt: line 26: unterminated listing block

Signed-off-by: Alison Schofield <alison.schofield@intel.com>
---
 Documentation/cxl/cxl-wait-sanitize.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 4d767c0c9b91d254e8ff0d7f0d3be04a498ad9f0

Comments

Dave Jiang Feb. 29, 2024, 10:11 p.m. UTC | #1
On 2/29/24 2:28 PM, alison.schofield@intel.com wrote:
> From: Alison Schofield <alison.schofield@intel.com>
> 
> Remove extra '==' to address these asciidoctor complaints:
> 
> Generating Documentation/cxl/cxl-wait-sanitize with a custom command
> ERROR: cxl-wait-sanitize.txt: line 1: non-conforming manpage title
> ERROR: cxl-wait-sanitize.txt: line 3: name section expected
> WARNING: cxl-wait-sanitize.txt: line 4: unterminated example block
> WARNING: cxl-wait-sanitize.txt: line 26: unterminated listing block
> 
> Signed-off-by: Alison Schofield <alison.schofield@intel.com>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>
> ---
>  Documentation/cxl/cxl-wait-sanitize.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/cxl/cxl-wait-sanitize.txt b/Documentation/cxl/cxl-wait-sanitize.txt
> index 9047b74f0716..e8f2044e4882 100644
> --- a/Documentation/cxl/cxl-wait-sanitize.txt
> +++ b/Documentation/cxl/cxl-wait-sanitize.txt
> @@ -1,7 +1,7 @@
>  // SPDX-License-Identifier: GPL-2.0
>  
>  cxl-wait-sanitize(1)
> -======================
> +====================
>  
>  NAME
>  ----
> 
> base-commit: 4d767c0c9b91d254e8ff0d7f0d3be04a498ad9f0
diff mbox series

Patch

diff --git a/Documentation/cxl/cxl-wait-sanitize.txt b/Documentation/cxl/cxl-wait-sanitize.txt
index 9047b74f0716..e8f2044e4882 100644
--- a/Documentation/cxl/cxl-wait-sanitize.txt
+++ b/Documentation/cxl/cxl-wait-sanitize.txt
@@ -1,7 +1,7 @@ 
 // SPDX-License-Identifier: GPL-2.0
 
 cxl-wait-sanitize(1)
-======================
+====================
 
 NAME
 ----