| Message ID | 20220304200643.1626110-1-vishal.l.verma@intel.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 633205122bc5a54b56ac6d961f9fc4aac917b0fd |
| Headers | show |
| Series | [ndctl] scripts/docsurgeon: Fix document header for section 1 man pages | expand |
On Fri, Mar 4, 2022 at 12:07 PM Vishal Verma <vishal.l.verma@intel.com> wrote: > > Document header generation for section 1 man pages (cxl-foo commands) was > missing the section number in parenthesis, i.e. it would generate: > > cxl-foo > ======= > > instead of: > > cxl-foo(1) > ========== > > resulting in asciidoc(tor) warnings. > What was the warning? Is a "Fixes:" tag appropriate? > Signed-off-by: Vishal Verma <vishal.l.verma@intel.com> > --- > scripts/docsurgeon | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/scripts/docsurgeon b/scripts/docsurgeon > index ca0ad78..1421ef7 100755 > --- a/scripts/docsurgeon > +++ b/scripts/docsurgeon > @@ -244,7 +244,7 @@ gen_cli() > > # Start template generation > printf "%s\n" "$copyright_cli" > "$tmp" > - gen_header "$name" >> "$tmp" > + gen_header "$name($_arg_section)" >> "$tmp" > gen_section_name "$name" >> "$tmp" > gen_section_synopsis_1 "$name" >> "$tmp" > gen_section "DESCRIPTION" >> "$tmp" > > base-commit: 55f36387ee8a88c489863103347ae275b1bc9191 > prerequisite-patch-id: 24c7dc0c646c21238e4741a9432739788c908de7 > prerequisite-patch-id: 2f5ab7c9c5b30aa585956e8a43dd2ec4d92d6afb > prerequisite-patch-id: 6ffa6ce0ea258fec17fa6066e4ee437ffd26307c > prerequisite-patch-id: 98f586353f89820d0b0e294c165dbbd7306cdd40 > prerequisite-patch-id: 83f078f0afe936dc6f0e172f59da14412981a030 > -- > 2.34.1 > >
On Mon, 2022-03-07 at 11:45 -0800, Dan Williams wrote: > On Fri, Mar 4, 2022 at 12:07 PM Vishal Verma > <vishal.l.verma@intel.com> wrote: > > > > Document header generation for section 1 man pages (cxl-foo > > commands) was > > missing the section number in parenthesis, i.e. it would generate: > > > > cxl-foo > > ======= > > > > instead of: > > > > cxl-foo(1) > > ========== > > > > resulting in asciidoc(tor) warnings. > > > > What was the warning? Is a "Fixes:" tag appropriate? I don't think so, this was only for man pages generated by 'docsurgeon', of which cxl-create-region (WIP) will be the first. No existing man pages needed to be modified. > > > Signed-off-by: Vishal Verma <vishal.l.verma@intel.com> > > --- > > scripts/docsurgeon | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/scripts/docsurgeon b/scripts/docsurgeon > > index ca0ad78..1421ef7 100755 > > --- a/scripts/docsurgeon > > +++ b/scripts/docsurgeon > > @@ -244,7 +244,7 @@ gen_cli() > > > > # Start template generation > > printf "%s\n" "$copyright_cli" > "$tmp" > > - gen_header "$name" >> "$tmp" > > + gen_header "$name($_arg_section)" >> "$tmp" > > gen_section_name "$name" >> "$tmp" > > gen_section_synopsis_1 "$name" >> "$tmp" > > gen_section "DESCRIPTION" >> "$tmp" > > > > base-commit: 55f36387ee8a88c489863103347ae275b1bc9191 > > prerequisite-patch-id: 24c7dc0c646c21238e4741a9432739788c908de7 > > prerequisite-patch-id: 2f5ab7c9c5b30aa585956e8a43dd2ec4d92d6afb > > prerequisite-patch-id: 6ffa6ce0ea258fec17fa6066e4ee437ffd26307c > > prerequisite-patch-id: 98f586353f89820d0b0e294c165dbbd7306cdd40 > > prerequisite-patch-id: 83f078f0afe936dc6f0e172f59da14412981a030 > > -- > > 2.34.1 > > > > >
diff --git a/scripts/docsurgeon b/scripts/docsurgeon index ca0ad78..1421ef7 100755 --- a/scripts/docsurgeon +++ b/scripts/docsurgeon @@ -244,7 +244,7 @@ gen_cli() # Start template generation printf "%s\n" "$copyright_cli" > "$tmp" - gen_header "$name" >> "$tmp" + gen_header "$name($_arg_section)" >> "$tmp" gen_section_name "$name" >> "$tmp" gen_section_synopsis_1 "$name" >> "$tmp" gen_section "DESCRIPTION" >> "$tmp"
Document header generation for section 1 man pages (cxl-foo commands) was missing the section number in parenthesis, i.e. it would generate: cxl-foo ======= instead of: cxl-foo(1) ========== resulting in asciidoc(tor) warnings. Signed-off-by: Vishal Verma <vishal.l.verma@intel.com> --- scripts/docsurgeon | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) base-commit: 55f36387ee8a88c489863103347ae275b1bc9191 prerequisite-patch-id: 24c7dc0c646c21238e4741a9432739788c908de7 prerequisite-patch-id: 2f5ab7c9c5b30aa585956e8a43dd2ec4d92d6afb prerequisite-patch-id: 6ffa6ce0ea258fec17fa6066e4ee437ffd26307c prerequisite-patch-id: 98f586353f89820d0b0e294c165dbbd7306cdd40 prerequisite-patch-id: 83f078f0afe936dc6f0e172f59da14412981a030