[Users] [ovirt test day 3] Documentation - man pages result
Hi, In the third ovirt test day I reviewed the manuals of a various ovirt tools and commands: Here are my findings (haven't reported any bugs for them): The engine-backup and engine-upgrade-check has no man pages, however help is available by providing the --help argument: No manual entry for engine-backup No manual entry for engine-upgrade-check No manual entry for ovirt-shell engine-config man page: ----------------------- 1. engine-config ACTION [--cver=version] [-p | --properties=/path/to/alternate/property/fie] [-c | --config=/path/to/alter-nate/config/file] s/fie/file 2. version relevant configuration version to use should be: --cver relevant configuration version to use 3. -g key, --get=key [--cversion=version] should be: -g key, --get=key [--cver=version] 4. The man pages misses an explanation how to set passwords using the --interactive argument which is described in the the output of "engine-config --help" engine-manage-domains man page: ------------------------------- In general, there is a great complexity in explaining the usage of the command, too many combinations. 1. Examples: -action=add -domain=example.com --user=admin --provider=IPA --passwordFile=/tmp/.pwd Add a domain called example.com, using user admin with ldap server type IPA and read the password from /tmp/.pwd. The arguments --user, --provider and --passwordFile should be replaced with -user, -provider and -passwordFile respectively. 2. changePasswordMsg - doesn't appear in the man page (appears only via --help) Thanks, Moti
Il 06/03/2014 23:32, Moti Asayag ha scritto:
Hi,
In the third ovirt test day I reviewed the manuals of a various ovirt tools and commands:
Here are my findings (haven't reported any bugs for them):
Please do, add keywords Documentation and ManPageChange for them
The engine-backup and engine-upgrade-check has no man pages, however help is available by providing the --help argument:
No manual entry for engine-backup No manual entry for engine-upgrade-check No manual entry for ovirt-shell
engine-config man page: ----------------------- 1. engine-config ACTION [--cver=version] [-p | --properties=/path/to/alternate/property/fie] [-c | --config=/path/to/alter-nate/config/file]
s/fie/file
2. version relevant configuration version to use should be: --cver relevant configuration version to use
3. -g key, --get=key [--cversion=version] should be: -g key, --get=key [--cver=version]
4. The man pages misses an explanation how to set passwords using the --interactive argument which is described in the the output of "engine-config --help"
engine-manage-domains man page: ------------------------------- In general, there is a great complexity in explaining the usage of the command, too many combinations.
1. Examples: -action=add -domain=example.com --user=admin --provider=IPA --passwordFile=/tmp/.pwd Add a domain called example.com, using user admin with ldap server type IPA and read the password from /tmp/.pwd.
The arguments --user, --provider and --passwordFile should be replaced with -user, -provider and -passwordFile respectively.
2. changePasswordMsg - doesn't appear in the man page (appears only via --help)
Thanks, Moti
-- Sandro Bonazzola Better technology. Faster innovation. Powered by community collaboration. See how it works at redhat.com
----- Original Message -----
From: "Sandro Bonazzola" <sbonazzo@redhat.com> To: "Moti Asayag" <masayag@redhat.com>, "users@oVirt.org" <users@ovirt.org> Cc: "Doron Fediuck" <dfediuck@redhat.com> Sent: Friday, March 7, 2014 9:15:50 AM Subject: Re: [ovirt test day 3] Documentation - man pages result
Il 06/03/2014 23:32, Moti Asayag ha scritto:
Hi,
In the third ovirt test day I reviewed the manuals of a various ovirt tools and commands:
Here are my findings (haven't reported any bugs for them):
Please do, add keywords Documentation and ManPageChange for them
Bugs were reported: Bug 1074301 - ovirt-shell has no man page Bug 1074300 - engine-manage-domains man page clarifications Bug 1074299 - engine-config man page clarifications Bug 1074302 - engine-upgrade-check has no man page Bug 1074303 - engine-backup has no man page
The engine-backup and engine-upgrade-check has no man pages, however help is available by providing the --help argument:
No manual entry for engine-backup No manual entry for engine-upgrade-check No manual entry for ovirt-shell
engine-config man page: ----------------------- 1. engine-config ACTION [--cver=version] [-p | --properties=/path/to/alternate/property/fie] [-c | --config=/path/to/alter-nate/config/file]
s/fie/file
2. version relevant configuration version to use should be: --cver relevant configuration version to use
3. -g key, --get=key [--cversion=version] should be: -g key, --get=key [--cver=version]
4. The man pages misses an explanation how to set passwords using the --interactive argument which is described in the the output of "engine-config --help"
engine-manage-domains man page: ------------------------------- In general, there is a great complexity in explaining the usage of the command, too many combinations.
1. Examples: -action=add -domain=example.com --user=admin --provider=IPA --passwordFile=/tmp/.pwd Add a domain called example.com, using user admin with ldap server type IPA and read the password from /tmp/.pwd.
The arguments --user, --provider and --passwordFile should be replaced with -user, -provider and -passwordFile respectively.
2. changePasswordMsg - doesn't appear in the man page (appears only via --help)
Thanks, Moti
-- Sandro Bonazzola Better technology. Faster innovation. Powered by community collaboration. See how it works at redhat.com
participants (2)
-
Moti Asayag -
Sandro Bonazzola