Bug 860714

Summary:	reliability parameter incorrectly documented
Product:	Red Hat Enterprise MRG	Reporter:	Andrew Replogle <areplogl>
Component:	Messaging_Programming_Reference	Assignee:	Joshua Wulf <jwulf>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Frantisek Reznicek <freznice>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	2.2	CC:	chetan, esammons, freznice, jskeoch, kbarfiel, lcarlon
Target Milestone:	2.2.3
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:	Instance Name: Not Defined Build: CSProcessor Builder Version 1.6 Build Filter: null Build Name: Build Date: 14-09-2012 11:17:28
Last Closed:	2012-11-19 04:27:29 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:

Description Andrew Replogle 2012-09-26 14:41:37 UTC

Description of problem:
The parameter in documentation on this page:
https://access.redhat.com/knowledge/docs/en-US/Red_Hat_Enterprise_MRG/2/html/Messaging_Programming_Reference/chap-Reliability_and_Quality_of_Service.html#Reliable_Link

States the reliability parameter for reliable is 'reliable' when it should be 'at-least-once'.

Version-Release number of selected component (if applicable):


How reproducible:
100%

Steps to Reproduce:
1. Go to link referenced above
2. read "Specifying a reliable link" section
3. Profit!!
  
Actual results:
states 'reliable' is the reliability parameter.

Expected results:
states 'at-least-once' is the reliability parameter.

Additional info:

Comment 1 Joshua Wulf 2012-10-16 04:39:18 UTC

Update Topic 10274

Comment 2 Joshua Wulf 2012-10-25 09:49:44 UTC

Changed text to read:

... include link: {'reliability': 'at-least-once'} in the address. 

For example:
sender = session.sender("amq.topic;{link: {'reliability': 'at-least-once'}}")



http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/2/html-single/Messaging_Programming_Reference/index.html#sect-Link_Reliability

Comment 3 Frantisek Reznicek 2012-10-30 12:36:36 UTC

Changes done for this defect are ok.

There are unfortunately two more references to 'reliable' as option variable (formatted in bold) which need to be adjusted, see below...

1] 8.3. Producer Flow Control/8.3.1. Flow Control
   Flow control relies on a reliable link between
                            ^^^^^^^^ should be italic or normal instead of bold as 'reliable' is not option value just definition of concept
2] 8.6. Transactions/8.6.1. Transactions
   Note that transactions require a reliable link to function.
                                    ^^^^^^^^ should be italic or normal instead of bold as 'reliable' is not option value just definition of concept


-> ASSIGNED

Comment 4 Joshua Wulf 2012-11-05 11:27:37 UTC

Section 8.3: http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/2/html-single/Messaging_Programming_Reference/index.html#sect-Producer_Flow_Control

Section 8.6: http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/2/html-single/Messaging_Programming_Reference/index.html#sect-Transactions

Comment 5 Frantisek Reznicek 2012-11-06 10:28:01 UTC

All necessary changes were added (incl. comment 3).

-> VERIFIED

Comment 6 Cheryn Tan 2012-11-19 04:27:29 UTC

MRG Messaging 2.2.3 docs have been released as of 14 November 2012, the docs are now available on https://access.redhat.com/knowledge/docs/Red_Hat_Enterprise_MRG/