[Cluster-devel] Problems in fence_drac.8, fence_na.8, fence_drac5.8

[Jan Pokorný <jpokorny@redhat.com>]

Hello Eric,

thanks for your heads-up;  I've CC'd fence-agents maintainer plus
see one note inline below.

On 18/06/13 01:14 -0400, esr at thyrsus.com wrote:
> Problems with fence_drac.8:
> 
> Ambiguous or invalid backslash.  This doesn't cause groff a problem.
> but it confuses doclifter and may confuse older troff implementations.
> 
> --- fence_drac.8-unpatched	2012-06-27 21:42:05.566240179 -0400
> +++ fence_drac.8	2012-06-27 21:42:57.718239206 -0400
> @@ -73,10 +73,10 @@
>  \fIagent = < param >\fR
>  This option is used by fence_node(8) and is ignored by fence_apc.
>  .TP
> -\fIcmd_prompt = < param >\fr
> +\fIcmd_prompt = < param >\fR
>  Force fence_drac to use cmd_prompt as the command prompt
>  .TP
> -\fIdrac_version = < param >\fr 
> +\fIdrac_version = < param >\fR 
>  Force fence_drac to treat the device as though it was for the specified drac version.
>  .TP
>  \fIdebug = < dumpfile >\fR
> @@ -88,7 +88,7 @@
>  \fIlogin = < param >\fR
>  Login name.
>  .TP
> -\fImodulename = < param >\fr
> +\fImodulename = < param >\fR
>  The module name of the blade when using DRAC/MC firmware.
>  .TP
>  \fIpasswd = < param >\fR

> Problems with fence_drac5.8:
> 
> Ambiguous or invalid backslash.  This doesn't cause groff a problem.
> but it confuses doclifter and may confuse older troff implementations.
> 
> --- fence_drac5.8-unpatched	2012-07-20 08:26:46.593786658 -0400
> +++ fence_drac5.8	2012-07-20 08:27:00.557786903 -0400
> @@ -44,7 +44,7 @@
>  .TP
>  .B -c, --command-prompt=<prompt>
>  . 
> -Force command prompt (Default Value: \$)
> +Force command prompt (Default Value: \\$)
>  	
>  .TP
>  .B -x, --ssh
> @@ -198,7 +198,7 @@
>  .TP
>  .B cmd_prompt
>  . 
> -Force command prompt (Default Value: \$)
> +Force command prompt (Default Value: \\$)
>  	
>  .TP
>  .B secure

For the one above I've filed
https://bugzilla.redhat.com/show_bug.cgi?id=978418

> Problems with fence_na.8:
> 
> Missing or garbled name section.  The most common form of garbling
> is a missing - or extra -. Or your manual page may have been generated
> by a tool that doesn't emit a NAME section as it should.  Or your page
> may add running text such as a version or authorship banner.  These
> problems make it impossible to lift the page to DocBook.  They
> can also confuse third-party manpage browsers and some implementations
> of man -k.
> 
> This page was generated from some sort of non-man markup.  Please
> fix the upstream markup so that it generates a well-formed
> manual page with the indicated corrections.
> 
> --- fence_na.8-unpatched	2012-07-04 16:06:48.253591845 -0400
> +++ fence_na.8	2012-07-04 16:07:34.345590983 -0400
> @@ -130,9 +130,7 @@
>  .if n .ad l
>  .nh
>  .SH "NAME"
> -fence_na
> -.PP
> -This is the fence agent for the Node Assassin fence device.
> +fence_na \- fence agent for the the Node Assassin fence device.
>  .SH "SYNOPSIS"
>  .IX Header "SYNOPSIS"
>  .Vb 1


-- 
Jan