Bug 959445 - Several connection options are missing in the doc
Summary: Several connection options are missing in the doc
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise MRG
Classification: Red Hat
Component: Messaging_Programming_Reference
Version: 2.3
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: 3.0
: ---
Assignee: Jared MORGAN
QA Contact: Petr Matousek
URL:
Whiteboard:
Depends On:
Blocks: 1047821
TreeView+ depends on / blocked
 
Reported: 2013-05-03 13:55 UTC by Petr Matousek
Modified: 2015-08-10 01:23 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
: 1047821 (view as bug list)
Environment:
Last Closed: 2015-01-22 15:27:45 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 661500 0 high CLOSED Connection option syntax is inconsistent across languages and documentation is ambiguous 2021-02-22 00:41:40 UTC

Internal Links: 661500

Description Petr Matousek 2013-05-03 13:55:46 UTC
Description of problem:

Several connection options are missing in the connection options list, please see:
http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/2/html-single/Messaging_Programming_Reference/index.html#Connection_Options

1. Following options are not available for python client, option description shall mention that:
tcp-nodelay
protocol

2. Following option are not listed in the table:

transport (replacement for protocol)
sasl_max_ssf
sasl_min_ssf
sasl_service
protocol - even if the option is listed there the description is wrong. The related option was renamed to 'transport', 'protocol' conn. option (support starts in qpid-0.20) now allows user to choose between amqp0-10 and amqp1.0 protocols. This option is not valid for python client.

3. Following option (that are available for python client only) are not listed in the table:
address_ttl
host
port
url
ssl_certfile
ssl_keyfile
ssl_trustfile

4. Wrong type is listed for following options (shall be float instead of int):
reconnect_interval	
reconnect_interval_max	
reconnect_interval_min	
reconnect_timeout	

Version-Release number of selected component (if applicable):
Messaging Programming Reference - Revision 2.0.0-32

How reproducible:
n/a

Steps to Reproduce:
n/a
  
Actual results:
incomplete list of supported connection options

Expected results:
The table (11.2. Connection Options) lists all the supported connection options

Additional info:

Comment 1 Joshua Wulf 2013-07-12 03:35:01 UTC
This is logged against 2.3. 

Does it also apply to 3.0?

Comment 2 Petr Matousek 2013-07-12 08:48:55 UTC
Fix for this issue was requested for Vienna, so yes, it applies to 3.0.

Comment 5 Petr Matousek 2014-01-02 09:50:56 UTC
The content was changed accordingly, there are only two minor issues remaining (in the connection options table):

1. reconnect limit type was incorrectly changed to float (shall be integer). 
2. url - mention that this option is "Python client only"

MPR, Revision: 569831

Comment 6 Petr Matousek 2014-01-02 10:00:20 UTC
(In reply to Petr Matousek from comment #5)
> The content was changed accordingly, there are only two minor issues
> remaining (in the connection options table):
> 
> 1. reconnect limit type was incorrectly changed to float (shall be integer). 
> 2. url - mention that this option is "Python client only"
> 
> MPR, Revision: 569831

There is one more issue:
3. Transport - this option is supported by python client as well. So the sentence "Not available in Python client." shall be removed.

Comment 7 Petr Matousek 2014-01-02 10:21:24 UTC
also cloned for MPR 2.x, please see bug 1047821.

Comment 8 Joshua Wulf 2014-01-05 23:37:46 UTC
reconnect_limit type -> integer
url -> Python client only
Transport -> removed "Python client only" note.

http://deathstar1.usersys.redhat.com:3000/builds/19948-Messaging_Programming_Reference/#Connection_Options_Reference

Comment 9 Petr Matousek 2014-01-06 13:39:00 UTC
Content approved.

MPR Revision 0.0.0-1 (Mon Dec 16 2013)
Built from Content Specification: 19948, Revision: 569831

-> VERIFIED


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