Bug 786529

Summary: qpid-config --limit-policy=none not documented
Product: Red Hat Enterprise MRG Reporter: Leonid Zhaldybin <lzhaldyb>
Component: Messaging_Installation_and_Configuration_GuideAssignee: Joshua Wulf <jwulf>
Status: CLOSED CURRENTRELEASE QA Contact: MRG Quality Engineering <mrgqe-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 2.1CC: esammons, iboverma, jross, jwulf, lcarlon
Target Milestone: 3.0   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-11-15 21:25:48 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Leonid Zhaldybin 2012-02-01 17:25:25 UTC 
Description of problem:
According to the documentation (see http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/2/html/Messaging_User_Guide/chap-Messaging_User_Guide-Queues.html), --limit policy parameter for qpid-config tool can have one of four values: reject, flow-to-disk, ring and ring-strict. But the help message for qpid-config --limit-policy states that there is one more option (namely, 'none'):

[root@lzhaldyb-rhel62x ~]# qpid-config --limit-policy=wrong
qpid-config: error: option --limit-policy: invalid choice: 'wrong' (choose from 'none', 'reject', 'flow-to-disk', 'ring', 'ring-strict')

Either this extra option should be deleted from the above help message, or it should be described properly in user documentation. In the latter case, this should be converted into a documentation bug.

Version-Release number of selected component (if applicable):
python-qpid-0.14-1.el6.noarch
python-qpid-qmf-0.14-3.el6.x86_64
qpid-qmf-0.14-3.el6.x86_64
qpid-tools-0.14-1.el6.noarch

How reproducible:
always


Steps to Reproduce:
1. Run qpid-config tool with --limit-policy parameter equal to some incorrect value (f.e., 'qpid-config --limit-policy=wrong')
2.
3.
  
Actual results:
Error message shows that there is undocumented option --limit-policy=none

Expected results:
No undocumented options shown.

Additional info:
Comment 1 Leonid Zhaldybin 2012-02-09 12:36:39 UTC 
The help message which the command 'qpid-config --help' prints out contains the following information:
[root@lzhaldyb-rhel62x ~]# qpid-config --help

Usage:  qpid-config [OPTIONS]
...

Queue Limit Actions

    none (default) - Use broker's default policy

So, this is in fact a documentation bug. The above line should be added to the Messaging User Guide.
Comment 2 Joshua Wulf 2012-11-07 05:18:58 UTC 
Added to list of options here:

http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/2/html-single/Messaging_Installation_and_Configuration_Guide/index.html#Create_and_Configure_Queues_using_qpid_config
Comment 3 Joshua Wulf 2012-11-07 05:26:16 UTC 
Actually, it's already published:

https://access.redhat.com/knowledge/docs/en-US/Red_Hat_Enterprise_MRG/2/html-single/Messaging_Installation_and_Configuration_Guide/index.html#Create_and_Configure_Queues_using_qpid_config