RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 978373 - Man pages for fence agents should make it clear when the parameter value is expected to be Python regular expression
Summary: Man pages for fence agents should make it clear when the parameter value is e...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: fence-agents
Version: 7.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Marek Grac
QA Contact: Cluster QE
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-06-26 13:22 UTC by Jan Pokorný [poki]
Modified: 2014-06-18 07:23 UTC (History)
2 users (show)

Fixed In Version: fence-agents-4.0.2-1.el7
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-06-13 11:24:13 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jan Pokorný [poki] 2013-06-26 13:22:24 UTC
Example:

# man fence_drac5 | grep -A1 cmd_prompt
       cmd_prompt
              Force command prompt (Default Value: ['\$'])

The dollar-sign is escaped only because it is treated as Python regular
expression under the hood.  This ought to be explained in the man page
so that no misunderstanding my arise when redefining the default value.
(something like "Force Python regex for command prompt").

For instance, if my fence device uses '.' as a prompt, I'd like to avoid
unneeded trial and error and use properly escaped '\.' as a cmd_prompt
value right away.

# rpm -q fence-agents-drac5
fence-agents-drac5-4.0.0-5.el7.x86_64


Two related notes:

1. to address using single-item-lists needlessly for default values
   (specifically in case of cmd_prompt as can also be observed above),
   I proposed a patch [1].  Thanks for considering it, Marku.

2. IIUIC, lists cannot be specified externally even when they
   are as default values (case of cmd_prompt at fence_apc, for instance)
   so the default values in man pages may still be confusing
   (patch [1] only fixed single-item-lists)


[1] https://www.redhat.com/archives/cluster-devel/2013-June/msg00181.html

Comment 1 Jan Pokorný [poki] 2013-06-26 13:25:22 UTC
Apparently, this applies to help texts (--help) as well.

Comment 3 Marek Grac 2013-07-01 12:52:50 UTC
Manual page was fixed in upstream:

https://git.fedorahosted.org/cgit/fence-agents.git/commit/?id=801d4575bff12924ae6ab56d4148e81a9e1cedd4

Problem with regex was solved by changing type of cmd-prompt - it is first value of newly created list. 

https://git.fedorahosted.org/cgit/fence-agents.git/commit/?id=c6d8c625c33451990473fef5ee735b18e28cdad1

Changing all command-prompts to just regex is surely an option but I don't like it very much because of fence agents that were not mentioned in patch. 

e.g. WTI:

all_opt["cmd_prompt"]["default"] = [ "RSM>", "MPC>", "IPS>", "TPS>", "NBB>", "NPS>", "VMR>" ]

Comment 6 Ludek Smid 2014-06-13 11:24:13 UTC
This request was resolved in Red Hat Enterprise Linux 7.0.

Contact your manager or support representative in case you have further questions about the request.


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