Public bug reported:
The individual man pages do not reveal the relation to the package,
which is confusing when seeing the man page.
The man pages note that they describe a "user command" and are in man section 1
(see below for a typical example page).
The command names use a common prefix "euare-" with no obvious meaning.
Even the last line does not help for a user who does not know what a "ools" is.
Based on this, it look like it describes some variant of the local
system commands, like belonging to a different desktop environment or
so.
So, there is very few information about what the commands belong to.
As solution, the man pages should at least say they are related to Eucalyptus;
even better, they could contain a one or two line summary stating the relation
of Eucalyptus to AWS.
(The package short description is "tools for interacting with AWS
API-compatible services" for example)
Version euca2ools 3.0.2-1ubuntu1
Example from man page of euare-groupmod:
------------------------------------------------------
EUARE-GROUPMOD(1) User Commands
EUARE-GROUPMOD(1)
NAME
euare-groupmod - Change the name and/or path of a group
SYNOPSIS
euare-groupmod -g GROUP [-n GROUP] [-p PATH] [--as-account
ACCOUNT]
[--region USER@REGION | -U URL] [-I KEY_ID] [-S KEY] [--debug]
[--debugger]
[--version] [-h]
DESCRIPTION
Change the name and/or path of a group
optional arguments:
[ ... ]
-h, --help
show this help message and exit
euca2ools 3.0.1 August 2013
EUARE-GROUPMOD(1)
------------------------------------------------------
** Affects: euca2ools (Ubuntu)
Importance: Undecided
Status: New
** Description changed:
+ The individual man pages do not reveal the relation to the package,
+ which is confusing when seeing the man page.
+
The man pages note that they describe a "user command" and are in man section
1 (see below for a typical example page).
The command names use a common prefix "euare-" with no obvious meaning.
Even the last line does not help for a user who does not know what a "ools"
is.
- Based on this, it look like it describes some variant of the local system
commands,
- like belonging to a different desktop environment or so.
+ Based on this, it look like it describes some variant of the local
+ system commands, like belonging to a different desktop environment or
+ so.
So, there is very few information about what the commands belong to.
As solution, the man pages should at least say they are related to Eucalyptus;
- even better, they could contain a one or two line summary stating the
relation
- of Eucalyptus to AWS.
+ even better, they could contain a one or two line summary stating the
relation of Eucalyptus to AWS.
(The package short description is "tools for interacting with AWS
API-compatible services" for example)
Version euca2ools 3.0.2-1ubuntu1
Example from man page of euare-groupmod:
------------------------------------------------------
EUARE-GROUPMOD(1) User Commands
EUARE-GROUPMOD(1)
-
-
-
- NAME
- euare-groupmod - Change the name and/or path of a group
-
- SYNOPSIS
- euare-groupmod -g GROUP [-n GROUP] [-p PATH] [--as-account
ACCOUNT]
- [--region USER@REGION | -U URL] [-I KEY_ID] [-S KEY] [--debug]
[--debugger]
- [--version] [-h]
-
- DESCRIPTION
- Change the name and/or path of a group
-
- optional arguments:
+
+ NAME
+ euare-groupmod - Change the name and/or path of a group
+
+ SYNOPSIS
+ euare-groupmod -g GROUP [-n GROUP] [-p PATH] [--as-account
ACCOUNT]
+ [--region USER@REGION | -U URL] [-I KEY_ID] [-S KEY] [--debug]
[--debugger]
+ [--version] [-h]
+
+ DESCRIPTION
+ Change the name and/or path of a group
+
+ optional arguments:
[ ... ]
- -h, --help
- show this help message and exit
-
-
-
- euca2ools 3.0.1 August 2013
EUARE-GROUPMOD(1)
+ -h, --help
+ show this help message and exit
+
+ euca2ools 3.0.1 August 2013
EUARE-GROUPMOD(1)
------------------------------------------------------
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1436645
Title:
Relation to eucalyptus no stated in man pages
To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/euca2ools/+bug/1436645/+subscriptions
--
ubuntu-bugs mailing list
ubuntu-bugs@lists.ubuntu.com
https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
