summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Hrozek <jhrozek@redhat.com>2010-10-27 09:11:30 -0400
committerRob Crittenden <rcritten@redhat.com>2010-11-08 15:23:03 -0500
commita874d5f8e5b432f699362730a994e838594735ec (patch)
tree3539b7d47c0e323bedf0d5b1889060f74f574c77
parent3bb0186199220a46ebe8fd93b9638b6603dc4b70 (diff)
downloadfreeipa-a874d5f8e5b432f699362730a994e838594735ec.tar.gz
freeipa-a874d5f8e5b432f699362730a994e838594735ec.tar.xz
freeipa-a874d5f8e5b432f699362730a994e838594735ec.zip
Clarify the description of --raw and -all
https://fedorahosted.org/freeipa/ticket/244
-rw-r--r--doc/examples/examples.py2
-rw-r--r--ipalib/frontend.py8
-rw-r--r--ipalib/plugins/misc.py2
3 files changed, 6 insertions, 6 deletions
diff --git a/doc/examples/examples.py b/doc/examples/examples.py
index d40ad8e3..9bef1a02 100644
--- a/doc/examples/examples.py
+++ b/doc/examples/examples.py
@@ -139,7 +139,7 @@ class exshowuser(Command):
Flag('all',
# the doc keyword argument is what you see when you go
# `ipa COMMAND --help` or `ipa help COMMAND`
- doc='retrieve all attributes',
+ doc='retrieve and print all attributes from the server. Affects command output.',
flags=['no_output'],
),
)
diff --git a/ipalib/frontend.py b/ipalib/frontend.py
index 73680ef2..f1b758d1 100644
--- a/ipalib/frontend.py
+++ b/ipalib/frontend.py
@@ -796,8 +796,8 @@ class Command(HasParam):
This method gets called by `HasParam._create_param_namespace()`.
- For commnds that return entries two special options are generated:
- --all makes the command retrieve/dispaly all attribute
+ For commands that return entries two special options are generated:
+ --all makes the command retrieve/display all attributes
--raw makes the command display attributes as they are stored
Subclasses can override this to customize how the arguments are
@@ -810,13 +810,13 @@ class Command(HasParam):
if isinstance(o, (Entry, ListOfEntries)):
yield Flag('all',
cli_name='all',
- doc=_('retrieve all attributes'),
+ doc=_('retrieve and print all attributes from the server. Affects command output.'),
exclude='webui',
flags=['no_output'],
)
yield Flag('raw',
cli_name='raw',
- doc=_('print entries as stored on the server'),
+ doc=_('print entries as stored on the server. Only affects output format.'),
exclude='webui',
flags=['no_output'],
)
diff --git a/ipalib/plugins/misc.py b/ipalib/plugins/misc.py
index 70ee61b7..d66e6964 100644
--- a/ipalib/plugins/misc.py
+++ b/ipalib/plugins/misc.py
@@ -44,7 +44,7 @@ class env(LocalOrRemote):
takes_options = LocalOrRemote.takes_options + (
Flag('all',
cli_name='all',
- doc=_('retrieve all attributes'),
+ doc=_('retrieve and print all attributes from the server. Affects command output.'),
exclude='webui',
flags=['no_output'],
default=True,