Merge branch 'issue-582' into 2.6-dev

client_admin/pulp/client/admin/auth.py

@@ -1,16 +1,3 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright © 2012 Red Hat, Inc.
-#
-# This software is licensed to you under the GNU General Public
-# License as published by the Free Software Foundation; either version
-# 2 of the License (GPLv2) or (at your option) any later version.
-# There is NO WARRANTY for this software, express or implied,
-# including the implied warranties of MERCHANTABILITY,
-# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
-# have received a copy of GPLv2 along with this software; if not, see
-# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
-
 import os
 from gettext import gettext as _
 
@@ -95,7 +82,9 @@ def __init__(self, context):
         # List Command
         list_command = PulpCliCommand('list', 'lists summary of users registered to the Pulp server', self.list)
         list_command.add_option(PulpCliFlag('--details', 'if specified, all the user information is displayed'))
-        list_command.add_option(PulpCliOption('--fields', 'comma-separated list of user fields; if specified, only the given fields will displayed', required=False))
+        list_command.add_option(PulpCliOption('--fields', 'comma-separated list of user fields; if specified, '
+                                                          'only the given fields will be displayed. '
+                                                          'Example: "login,name."', required=False))
         self.add_command(list_command)
 
         # Search Command
@@ -215,7 +204,9 @@ def __init__(self, context):
         # List Command
         list_command = PulpCliCommand('list', 'lists summary of roles on the Pulp server', self.list)
         list_command.add_option(PulpCliFlag('--details', 'if specified, all the role information is displayed'))
-        list_command.add_option(PulpCliOption('--fields', 'comma-separated list of role fields; if specified, only the given fields will displayed', required=False))
+        list_command.add_option(PulpCliOption('--fields', 'comma-separated list of role fields; if specified, '
+                                                          'only the given fields will be displayed. '
+                                                          'Example: "id,users."', required=False))
         self.add_command(list_command)
 
     def create(self, **kwargs):

client_lib/pulp/client/commands/consumer/query.py

@@ -151,7 +151,7 @@ def run(self, **kwargs):
 
 OPTION_FIELDS = PulpCliOption('--fields',
                               _('comma-separated list of consumer fields; if specified only the'
-                                ' given fields will be displayed'),
+                                ' given fields will be displayed. Example: "id,display_name".'),
                               required=False)
 
 OPTION_EVENT_TYPE = PulpCliOption('--event-type',

client_lib/pulp/client/commands/criteria.py

@@ -14,7 +14,7 @@
 override any options specified from the 'Filters' section
 below.""").replace('\n', ' ')
 _FIELDS_DESCRIPTION = _("""comma-separated list of resource fields. Do not
-include spaces. Default is all fields.""".replace('\n', ' '))
+include spaces. Default is all fields. Example: 'id,display_name'""".replace('\n', ' '))
 _SORT_DESCRIPTION = _("""field name, a comma, and either the word "ascending" or
 "descending". The comma and direction are optional, and the direction
 defaults to ascending. Do not put a space before or after the comma. For

client_lib/pulp/client/commands/repo/cudl.py

@@ -301,7 +301,8 @@ def __init__(self, context, name='list', description=DESC_LIST, method=None,
         self.add_option(PulpCliFlag('--details', d))
 
         d = _('comma-separated list of repository fields; if specified, '
-              'only the given fields will displayed')
+              'only the given fields will be displayed. '
+              'Example: "id,description,display_name,content_unit_counts."')
         self.add_option(PulpCliOption('--fields', d, required=False))
 
         self.supports_all = include_all_flag

client_lib/pulp/client/commands/repo/group.py

@@ -160,9 +160,9 @@ def __init__(self, context, name='list', description=DESC_LIST, method=None):
         self.add_option(PulpCliFlag('--details', _('if specified, all the repo group information '
                                                    'is displayed')))
         self.add_option(PulpCliOption('--fields', _('comma-separated list of repo group fields; if '
-                                                    'specified, only the given fields will '
-                                                    'displayed'),
-                                      required=False))
+                                                    'specified, only the given fields will be '
+                                                    'displayed. Example: "id,description,'
+                                                    'display_name."'), required=False))
 
     def run(self, **kwargs):
         self.prompt.render_title(_('Repository Groups'))

docs/user-guide/admin-client/consumer.rst

@@ -76,7 +76,7 @@ bindings are waiting for that remote action to take place.
     Available Arguments:
 
       --fields   - comma-separated list of consumer fields; if specified only the
-                   given fields will be displayed
+                   given fields will be displayed. Example: "id,display_name"
       --bindings - if specified, the bindings information is displayed
       --details  - if specified, all of the consumer information is displayed