[waffle] [PATCH v2 3/4] waffle utils: add wflinfo man page

Chad Versace chad.versace at linux.intel.com
Mon Jan 6 10:44:31 PST 2014


On Mon, Dec 23, 2013 at 09:48:35PM -0800, Jordan Justen wrote:
> Signed-off-by: Jordan Justen <jordan.l.justen at intel.com>
> ---
>  .gitignore                            |   1 +
>  doc/html/man/index.html               |   3 +
>  man/.gitignore                        |   1 +
>  man/common/author-jordan.l.justen.xml |   8 ++
>  man/html.cmake                        |   2 +
>  man/html.xsl                          |   8 ++
>  man/manpages.cmake                    |   5 +
>  man/waffle.7.xml                      |   1 +
>  man/wflinfo.1.xml                     | 182 ++++++++++++++++++++++++++++++++++
>  9 files changed, 211 insertions(+)
>  create mode 100644 man/common/author-jordan.l.justen.xml
>  create mode 100644 man/wflinfo.1.xml
>

This patch is very thorough :) And I didn't know about the <replaceable>
element.

It looks good to me, except for one thing. I inspected several
manpages in volume 1, [git(1), ls(1), gdb(1), vim(1)], and in each the
Description immediately follows the Synopsis and occurs before any
section about Options. The wflinfo manpage should follow that same
tradition. That is, the section ordering should change from

> +  <refsect1>
> +    <title>Required Parameters</title>

> +  <refsect1>
> +    <title>Options</title>

> +  <refsect1>
> +    <title>Description</title>

to

> +  <refsect1>
> +    <title>Description</title>

> +  <refsect1>
> +    <title>Required Parameters</title>

> +  <refsect1>
> +    <title>Options</title>


With that change,
Reviewed-by: Chad Versace <chad.versace at linux.intel.com>


More information about the waffle mailing list