Bug 978418

Summary: Manual pages for fence agents: make sure backslashes in (default) values are escaped
Product: Red Hat Enterprise Linux 7 Reporter: Jan Pokorný [poki] <jpokorny>
Component: fence-agentsAssignee: Marek Grac <mgrac>
Status: CLOSED WORKSFORME QA Contact: Cluster QE <mspqa-list>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.0CC: cluster-maint
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-07-01 12:20:08 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Jan Pokorný [poki] 2013-06-26 14:48:45 UTC
Example (note: patch [1] was already applied, but conceptually the
same without it):

$ cd fence-agents
$ { ./autogen.sh && ./configure && make;} &>/dev/null || echo failed
$ man --warnings=w -l fence/agents/drac5/fence_drac5.8 2>&1 >/dev/null
> <standard input>:37: bad argument name `)'
> <standard input>:196: bad argument name `)'

$ sed -n -e '37p' -e '196p' fence/agents/drac5/fence_drac5.8
> Force command prompt (Default Value: \$)
> Force command prompt (Default Value: \$)

When this is changed to (i.e., doubled backslashes):
> Force command prompt (Default Value: \\$)
warnings are not longer emitted while the man page itself remains displayed
correctly.

Presumably, this is something to be handled in fence2man.xsl template.

Related:
[bug 978373]
[1] http://www.redhat.com/archives/cluster-devel/2013-June/msg00181.html
[2] http://www.redhat.com/archives/cluster-devel/2013-June/msg00147.html

Comment 2 Marek Grac 2013-07-01 12:20:08 UTC
This problem is already solved in versions 4.0.x