[Cluster-devel] Fix fence-agents manpages

[Cluster-devel] Fix fence-agents manpages

[Arnaud Quette]

Hi Cluster-devel list,

You will find attached a patch originating from Ubuntu (Andres
Rodriguez), that fixes a few issues in manpages (namely fence_drac and
fence_scsi).

Please consider applying it.

As a side note, you may want to consider Asciidoc [1] to handle
generation of manpages, in groff and html format.
This already takes care of the groff formating, and would avoid the
above kind of issues.
That said, iirc you're also doing some POD style extraction, so it may
not be fully relevant.

cheers,
Arnaud
-- 
Linux / Unix Expert R&D - Eaton - http://powerquality.eaton.com
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://www.debian.org
Free Software Developer - http://arnaud.quette.free.fr/
-------------- next part --------------
diff --git a/fence/agents/drac/fence_drac.8 b/fence/agents/drac/fence_drac.8
index 3660c5a..cb25774 100644
--- a/fence/agents/drac/fence_drac.8
+++ b/fence/agents/drac/fence_drac.8
@@ -16,7 +16,7 @@ the card.  By default, the telnet interface is not enabled.  To enable the
 interface, you will need to use the racadm command in the racser-devel rpm 
 available from Dell.  To enable telnet on the DRAC:
 
-[root]# racadm config -g cfgSerial -o cfgSerialTelnetEnable 1
+[root]# racadm config \-g cfgSerial \-o cfgSerialTelnetEnable 1
 
 [root]# racadm racreset
 
diff --git a/fence/agents/scsi/fence_scsi.8 b/fence/agents/scsi/fence_scsi.8
index f1a29ea..b81ba0d 100644
--- a/fence/agents/scsi/fence_scsi.8
+++ b/fence/agents/scsi/fence_scsi.8
@@ -23,13 +23,13 @@ occurs, the fence_scsi agent will remove the key belonging to the
 failed node from the device(s). The failed node will no longer be able
 to write to the device(s). A manual reboot is required.
 
-Keys are either be specified manually (see -k option) or generated
-automatically (see -n option). Automatic key generation requires that
+Keys are either be specified manually (see \-k option) or generated
+automatically (see \-n option). Automatic key generation requires that
 cman be running. Keys will then be generated using the cluster ID and
 node ID such that each node has a unique key that can be determined by
 any other node in the cluster.
 
-Devices can either be specified manually (see -d option) or discovered
+Devices can either be specified manually (see \-d option) or discovered
 automatically. Multiple devices can be specified manually by using a
 comma-separated list. If no devices are specified, the fence_scsi
 agent will attempt to discover devices by looking for cluster volumes
@@ -42,7 +42,7 @@ and created registrations for each path.
 .TP
 \fB-o\fP \fIaction\fR
 Fencing action. This value can be "on", "off", or "status". All
-actions require either a key (see -k option) or node name (see -n
+actions require either a key (see \-k option) or node name (see \-n
 option). For "on", the agent will attempt to register with the
 device(s) and create a reservation if none exists. The "off" action
 will attempt to remove a node's key from the device(s). The "status"
@@ -61,7 +61,7 @@ Log output to file.
 \fB-n\fP \fInodename\fR
 Name of the node to be fenced. The node name is used to generate the
 key value used for the current operation. This option will be ignored
-when used with the -k option.
+when used with the \-k option.
 .TP
 \fB-k\fP \fIkey\fR
 Key to use for the current operation. This key should be unique to a
@@ -88,19 +88,19 @@ Print out a version message, then exit.
 This option is used by fence_node(8) and is ignored by fence_scsi.
 .TP
 \fInodename = "param"\fR
-Same as -n option.
+Same as \-n option.
 .TP
 \fIaction = "param" \fR
-Same as -o option.
+Same as \-o option.
 .TP
 \fIdevices = "param"\fR
-Same as -d option.
+Same as \-d option.
 .TP
 \fIlogfile = "param"\fR
-Same as -f option
+Same as \-f option
 .TP
 \fIkey = "param"\fR
-Same as -k option.
+Same as \-k option.
 .TP
 \fIaptpl = "1"
 Enable the APTPL flag. Default is 0 (disable).

[Cluster-devel] Fix fence-agents manpages

[Fabio M. Di Nitto]

On 12/6/2011 2:27 PM, Arnaud Quette wrote:
> Hi Cluster-devel list,
> 
> You will find attached a patch originating from Ubuntu (Andres
> Rodriguez), that fixes a few issues in manpages (namely fence_drac and
> fence_scsi).


I wonder why the ubuntu/canonical maintainers can?t post patches
directly for upstream inclusion.

> 
> Please consider applying it.
> 
> As a side note, you may want to consider Asciidoc [1] to handle
> generation of manpages, in groff and html format.
> This already takes care of the groff formating, and would avoid the
> above kind of issues.
> That said, iirc you're also doing some POD style extraction, so it may
> not be fully relevant.

goal is to have all manpages generated at build time via fence_agent -o
metadata output. Most of patches already exists for those few agents
that don?t it.

Fabio

[Cluster-devel] Fix fence-agents manpages

[Arnaud Quette]

Hi Fabio,

2011/12/6 Fabio M. Di Nitto <fabbione@fabbione.net>:
> On 12/6/2011 2:27 PM, Arnaud Quette wrote:
>> Hi Cluster-devel list,
>>
>> You will find attached a patch originating from Ubuntu (Andres
>> Rodriguez), that fixes a few issues in manpages (namely fence_drac and
>> fence_scsi).
>
>
> I wonder why the ubuntu/canonical maintainers can?t post patches
> directly for upstream inclusion.

they obviously can Fabio.
But I proposed to do this on my side, since I still have some things
to do around fence_eaton...
That way, they can focus on other things.

After all, it's just posting an email. The actual and important work
is to catch bugs and fix this ;-)

>> Please consider applying it.
>>
>> As a side note, you may want to consider Asciidoc [1] to handle
>> generation of manpages, in groff and html format.
>> This already takes care of the groff formating, and would avoid the
>> above kind of issues.
>> That said, iirc you're also doing some POD style extraction, so it may
>> not be fully relevant.
>
> goal is to have all manpages generated at build time via fence_agent -o
> metadata output. Most of patches already exists for those few agents
> that don?t it.

ok, that confirms the "POD" style approach.
I wasn't sure if you were standardizing on this, or going away from.

cheers,
Arnaud
-- 
Linux / Unix Expert R&D - Eaton - http://powerquality.eaton.com
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://www.debian.org
Free Software Developer - http://arnaud.quette.free.fr/

[Cluster-devel] Fix fence-agents manpages

[Fabio M. Di Nitto]

On 12/6/2011 4:05 PM, Arnaud Quette wrote:
> Hi Fabio,
> 
> 2011/12/6 Fabio M. Di Nitto <fabbione@fabbione.net>:
>> On 12/6/2011 2:27 PM, Arnaud Quette wrote:
>>> Hi Cluster-devel list,
>>>
>>> You will find attached a patch originating from Ubuntu (Andres
>>> Rodriguez), that fixes a few issues in manpages (namely fence_drac and
>>> fence_scsi).
>>
>>
>> I wonder why the ubuntu/canonical maintainers can?t post patches
>> directly for upstream inclusion.
> 
> they obviously can Fabio.
> But I proposed to do this on my side, since I still have some things
> to do around fence_eaton...
> That way, they can focus on other things.
> 
> After all, it's just posting an email. The actual and important work
> is to catch bugs and fix this ;-)
> 
>>> Please consider applying it.
>>>
>>> As a side note, you may want to consider Asciidoc [1] to handle
>>> generation of manpages, in groff and html format.
>>> This already takes care of the groff formating, and would avoid the
>>> above kind of issues.
>>> That said, iirc you're also doing some POD style extraction, so it may
>>> not be fully relevant.
>>
>> goal is to have all manpages generated at build time via fence_agent -o
>> metadata output. Most of patches already exists for those few agents
>> that don?t it.
> 
> ok, that confirms the "POD" style approach.
> I wasn't sure if you were standardizing on this, or going away from.

The patch will be "obsoleted" in the fence-agents release or max two.

Fabio

[Cluster-devel] Fix fence-agents manpages

[Arnaud Quette]

2011/12/6 Fabio M. Di Nitto <fabbione@fabbione.net>

> On 12/6/2011 4:05 PM, Arnaud Quette wrote:
> > Hi Fabio,
> >
> > 2011/12/6 Fabio M. Di Nitto <fabbione@fabbione.net>:
> >> On 12/6/2011 2:27 PM, Arnaud Quette wrote:
> >>> Hi Cluster-devel list,
> >>>
> >>> You will find attached a patch originating from Ubuntu (Andres
> >>> Rodriguez), that fixes a few issues in manpages (namely fence_drac and
> >>> fence_scsi).
> >>
> >>
> >> I wonder why the ubuntu/canonical maintainers can?t post patches
> >> directly for upstream inclusion.
> >
> > they obviously can Fabio.
> > But I proposed to do this on my side, since I still have some things
> > to do around fence_eaton...
> > That way, they can focus on other things.
> >
> > After all, it's just posting an email. The actual and important work
> > is to catch bugs and fix this ;-)
> >
> >>> Please consider applying it.
> >>>
> >>> As a side note, you may want to consider Asciidoc [1] to handle
> >>> generation of manpages, in groff and html format.
> >>> This already takes care of the groff formating, and would avoid the
> >>> above kind of issues.
> >>> That said, iirc you're also doing some POD style extraction, so it may
> >>> not be fully relevant.
> >>
> >> goal is to have all manpages generated at build time via fence_agent -o
> >> metadata output. Most of patches already exists for those few agents
> >> that don?t it.
> >
> > ok, that confirms the "POD" style approach.
> > I wasn't sure if you were standardizing on this, or going away from.
>
> The patch will be "obsoleted" in the fence-agents release or max two.
>

thanks for these info.
I take it as this patch is discarded, and the proper fix will come very
soon.

cheers,
Arnaud
-- 
Linux / Unix Expert R&D - Eaton - http://powerquality.eaton.com
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://www.debian.org
Free Software Developer - http://arnaud.quette.free.fr/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/cluster-devel/attachments/20111207/084f7b9d/attachment.htm>

[Cluster-devel] Fix fence-agents manpages

[Fabio M. Di Nitto]

On 12/7/2011 9:53 AM, Arnaud Quette wrote:

>     >
>     > ok, that confirms the "POD" style approach.
>     > I wasn't sure if you were standardizing on this, or going away from.
> 
>     The patch will be "obsoleted" in the fence-agents release or max two.
> 
> 
> thanks for these info.
> I take it as this patch is discarded, and the proper fix will come very
> soon.

Pretty much yes :)

Fabio