Bug 978418 - Manual pages for fence agents: make sure backslashes in (default) values are escaped
Manual pages for fence agents: make sure backslashes in (default) values are ...
Status: CLOSED WORKSFORME
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: fence-agents (Show other bugs)
7.0
Unspecified Unspecified
unspecified Severity unspecified
: rc
: ---
Assigned To: Marek Grac
Cluster QE
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2013-06-26 10:48 EDT by Jan Pokorný
Modified: 2013-07-01 08:20 EDT (History)
1 user (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2013-07-01 08:20:08 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Jan Pokorný 2013-06-26 10:48:45 EDT
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 08:20:08 EDT
This problem is already solved in versions 4.0.x

Note You need to log in before you can comment on or make changes to this bug.