Bug 980566 - Update documentation for role names to reflect possibility of using custom values.
Summary: Update documentation for role names to reflect possibility of using custom va...
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Beaker
Classification: Retired
Component: Doc
Version: 0.13
Hardware: Unspecified
OS: Unspecified
low
unspecified
Target Milestone: 27.0
Assignee: Carol Bouchard
QA Contact: tools-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-07-02 18:05 UTC by Luigi Toscano
Modified: 2019-12-11 07:45 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-12-11 07:45:03 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Beaker Project Gerrit 6674 0 'None' 'MERGED' 'Improve Beaker Multihost doc role usage' 2019-12-02 19:22:02 UTC

Description Luigi Toscano 2013-07-02 18:05:49 UTC
Description of problem:
The description of roles in the "Multihost tasks" section[1] could give the impression that CLIENTS, SERVERS and DRIVERS are the only possible choice as role, but any valid bash variable name can be used as role.
The description of role names could be more generic.

See https://lists.fedorahosted.org/pipermail/beaker-devel/2013-July/000612.html

[1] http://beaker-project.org/docs/user-guide/multihost.html

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

Comment 2 Raymond Mancy 2013-07-02 23:00:53 UTC
SERVERS, CLIENTS and DRIVERS are actually hardcoded into certain helper functions of the rhts test env (actually, report_finish() is the only one I can see).

If your test does not rely on this (which it may not) then yes, any other value for ROLE will be fine. However, the integration of those role values should either be documented, or removed from rhts.

Comment 3 Nick Coghlan 2013-07-03 00:57:02 UTC
Any documentation updates should mention cases where the name *does* matter with respect to any helper functions, but the current docs certainly give the wrong impression.


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