Red Hat Bugzilla – Bug 784996
JON 3.0.1 RC#1 CLI Doc Table 2.3 lists method on "rhq" that is not available
Last modified: 2012-06-21 19:16:02 EDT
Description of problem: JON 3.0.1 RC#1 CLI Doc Table 2.3 lists method on "rhq" that is not available. The documentation lists that the "rhq" object has the commands "login", "logout", and "quit". Using tab completion, I observe that "rhq" only has the methods "login" and "logout" ... and that if one were to type "rhq.quit()" nothing happens anyways.
Version-Release number of selected component (if applicable): JON 3.0.1 RC#1
How reproducible: 100%
Steps to Reproduce:
1. ./rhq-cli.sh -u rhqadmin -p rhqadmin
2. type "rhq" ... then tab (for tab completion)
3. observe that only the methods "login" and "logout" are on this object
4. read the doc that says "login, logout, and quit" are on this object
5. try "rhq.quit()" ... nothing happens
Actual results: a documented method does not exist
Expected results: the CLI documentation for the table in 2.3 accurately reflects the API
ditto above for the documented "DataAccess" object
12/30/2012 BZ triage meeting mfoley, ccrouch, loleary, asantos
DataAccess should be DataAccessManager. I'm checking, but I think that's the only one missing the required "Manager" on the end.
From what I understand from Ian and John, these commands are native to the CLI. I know the usage is ...
$ exec -f foo.js
So, you wouldn't really call rhq.quit. I don't know why rhq.login and rhq.logout seem to work; I did find those in the client API, so my guess is that those are public for some reason, but the other commands -- quit, exec, version -- aren't.
Anyway, I removed that rhq row from the table and move the information about the commands to the top of the CLI Commands section. login/logout/etc. are already covered in the Commands section, and it seems more confusing than helpful to have that table row there, especially since they aren't variables.
Problem solved! rhq.login and rhq.logout can be called in a server-side script, while exec, version, and quit only work in the interactive CLI.