Bug 1080591

Summary: pcs.8: .TP macro issue
Product: Red Hat Enterprise Linux 7 Reporter: Jan Pokorný [poki] <jpokorny>
Component: pcsAssignee: Tomas Jelinek <tojeline>
Status: CLOSED ERRATA QA Contact: Cluster QE <mspqa-list>
Severity: low Docs Contact:
Priority: low    
Version: 7.0CC: cfeist, cluster-maint, fdinitto, rsteiger
Target Milestone: rcKeywords: EasyFix
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: pcs-0.9.126-1.el7 Doc Type: Bug Fix
Doc Text:
Cause: improper usage of .TP macro on some places Consequence: confusing line break and indentation on those places Fix: use .TP macro properly Result: manpage displayed correctly
 Story Points: ---
Clone Of: Environment:
Last Closed: 2015-03-05 09:19: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:
Attachments:
Description Flags
proposed fix none

Description Jan Pokorný [poki] 2014-03-25 17:47:44 UTC 
Currently the man page does not use .TP macro properly in some cases,
resulting in some confusion especially in case of more convoluted
subcommand syntax.

For instance:

>        colocation set <resource1>  <resource2>  [resourceN]...  [setop‐
>        tions] ...
>               [set    <resourceX>    <resourceY>    ...]    [setoptions
>               <name>=<value>...] Create a colocation constraint with  a
>               resource set

which is caused by intended label being split on multiple lines; when
corrected:

>        colocation set <resource1>  <resource2>  [resourceN]...  [setop‐
>        tions]   ...   [set  <resourceX>  <resourceY>  ...]  [setoptions
>        <name>=<value>...]
>               Create a colocation constraint with a resource set
Comment 2 Tomas Jelinek 2014-05-26 12:16:00 UTC 
Created attachment 899291 [details]
proposed fix
Comment 3 Tomas Jelinek 2014-05-26 12:17:12 UTC 
test:
Display pcs manpage. Check that description of the commands is formatted like this:

command parameter parameter
       command description

or

cmnd   command description

instead of this:

command parameter
       parameter command description
Comment 4 Tomas Jelinek 2014-09-11 08:33:02 UTC 
Before Fix:
[root@rh70-node1 ~]# rpm -q pcs
pcs-0.9.115-32.el7.x86_64
[root@rh70-node1 ~]# man pcs
{output trimmed}
       colocation set <resource1> <resource2> [resourceN]... [setoptions] ...
              [set <resourceX> <resourceY> ...] [setoptions <name>=<value>...]
              Create a colocation constraint with a resource set
{output trimmed}

After Fix:
[root@rh70-node1 ~]# rpm -q pcs
pcs-0.9.126-1.el7.x86_64
[root@rh70-node1 ~]# man pcs
{output trimmed}
       colocation  set  <resource1>  <resource2> [resourceN]... [options] [set
       <resourceX>    <resourceY>    ...    [options]]    [setoptions    [con‐
       straint_options]]
              Create  a  colocation  constraint with a resource set. Available
{output trimmed}
Comment 8 errata-xmlrpc 2015-03-05 09:19:08 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHBA-2015-0415.html