Bug 786529 - qpid-config --limit-policy=none not documented
Summary: qpid-config --limit-policy=none not documented
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise MRG
Classification: Red Hat
Component: Messaging_Installation_and_Configuration_Guide
Version: 2.1
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: 3.0
: ---
Assignee: Joshua Wulf
QA Contact: MRG Quality Engineering
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-02-01 17:25 UTC by Leonid Zhaldybin
Modified: 2014-11-09 22:38 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-11-15 21:25:48 UTC
Target Upstream Version:


Attachments (Terms of Use)

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.


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