-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

https://fedorahosted.org/freeipa/ticket/244

If I understand the code correctly, --all is not really a parameter that
affects only output, it also causes all attributes to be retrieved from
the server, so I have adjusted the description just a little.

- --raw now mentions it only affects output.

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/

iEYEARECAAYFAkzK4loACgkQHsardTLnvCWp6wCggT3duxWyZbG5KQQHYqBYCiVm
FPoAoKQrdF+AomtZewsmKWbqKcxGAiCw
=yQ4g
-----END PGP SIGNATURE-----
From beab1dd6e331420f5bd505f2fb518cf345334830 Mon Sep 17 00:00:00 2001
From: Jakub Hrozek <jhro...@redhat.com>
Date: Wed, 27 Oct 2010 09:11:30 -0400
Subject: [PATCH] Clarify the description of --raw and -all

https://fedorahosted.org/freeipa/ticket/244
---
 doc/examples/examples.py |    2 +-
 ipalib/frontend.py       |    8 ++++----
 ipalib/plugins/misc.py   |    2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/examples/examples.py b/doc/examples/examples.py
index d40ad8e..83f5bd9 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',
             flags=['no_output'],
         ),
     )
diff --git a/ipalib/frontend.py b/ipalib/frontend.py
index 73680ef..3cccc7e 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'),
                     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 70ee61b..faf8bb3 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'),
             exclude='webui',
             flags=['no_output'],
             default=True,
-- 
1.7.2.3

Attachment: jhrozek-freeipa-0001-Clarify-the-description-of-raw-and-all.patch.sig
Description: PGP signature

_______________________________________________
Freeipa-devel mailing list
Freeipa-devel@redhat.com
https://www.redhat.com/mailman/listinfo/freeipa-devel

Reply via email to