Update argument docs to reflect dropped CSV support

https://fedorahosted.org/freeipa/ticket/3352
This commit is contained in:
Petr Viktorin
2013-02-14 12:01:16 -05:00
committed by Martin Kosek
parent 3a96cbc518
commit 5752b35d16
8 changed files with 27 additions and 29 deletions

View File

@@ -444,7 +444,7 @@ class aci(Object):
Str('permissions+', validate_permissions,
cli_name='permissions',
label=_('Permissions'),
doc=_('comma-separated list of permissions to grant' \
doc=_('Permissions to grant' \
'(read, write, add, delete, all)'),
csv=True,
normalizer=_normalize_permissions,
@@ -452,8 +452,8 @@ class aci(Object):
),
Str('attrs*',
cli_name='attrs',
label=_('Attributes'),
doc=_('Comma-separated list of attributes'),
label=_('Attributes to which the permission applies'),
doc=_('Attributes'),
csv=True,
flags=('virtual_attribute',),
),

View File

@@ -1436,7 +1436,7 @@ class LDAPModMember(LDAPQuery):
Base class for member manipulation.
"""
member_attributes = ['member']
member_param_doc = _('comma-separated list of %s')
member_param_doc = _('%s')
member_count_out = ('%i member processed.', '%i members processed.')
def get_options(self):
@@ -1478,7 +1478,7 @@ class LDAPAddMember(LDAPModMember):
"""
Add other LDAP entries to members.
"""
member_param_doc = _('comma-separated list of %s to add')
member_param_doc = _('%s to add')
member_count_out = ('%i member added.', '%i members added.')
allow_same = False
@@ -1574,7 +1574,7 @@ class LDAPRemoveMember(LDAPModMember):
"""
Remove LDAP entries from members.
"""
member_param_doc = _('comma-separated list of %s to remove')
member_param_doc = _('%s to remove')
member_count_out = ('%i member removed.', '%i members removed.')
has_output = (
@@ -1899,7 +1899,7 @@ class LDAPModReverseMember(LDAPQuery):
Base class for reverse member manipulation.
"""
reverse_attributes = ['member']
reverse_param_doc = _('comma-separated list of %s')
reverse_param_doc = _('%s')
reverse_count_out = ('%i member processed.', '%i members processed.')
has_output_params = global_output_params
@@ -1924,7 +1924,7 @@ class LDAPAddReverseMember(LDAPModReverseMember):
The call looks like "add A to B" but in fact executes
add B to A to handle reverse membership.
"""
member_param_doc = _('comma-separated list of %s to add')
member_param_doc = _('%s to add')
member_count_out = ('%i member added.', '%i members added.')
show_command = None
@@ -2024,7 +2024,7 @@ class LDAPRemoveReverseMember(LDAPModReverseMember):
The call looks like "remove A from B" but in fact executes
remove B from A to handle reverse membership.
"""
member_param_doc = _('comma-separated list of %s to remove')
member_param_doc = _('%s to remove')
member_count_out = ('%i member removed.', '%i members removed.')
show_command = None

View File

@@ -81,14 +81,13 @@ class delegation(Object):
Str('permissions*',
cli_name='permissions',
label=_('Permissions'),
doc=_('Comma-separated list of permissions to grant ' \
'(read, write). Default is write.'),
doc=_('Permissions to grant (read, write). Default is write.'),
csv=True,
),
Str('attrs+',
cli_name='attrs',
label=_('Attributes'),
doc=_('Comma-separated list of attributes'),
doc=_('Attributes to which the delegation applies'),
csv=True,
normalizer=lambda value: value.lower(),
),

View File

@@ -557,7 +557,7 @@ class DNSRecord(Str):
label_format = _("%s record")
part_label_format = "%s %s"
doc_format = _('Comma-separated list of raw %s records')
doc_format = _('Raw %s records')
option_group_format = _('%s Record')
see_rfc_msg = _("(see RFC %s for details)")
part_name_format = "%s_part_%s"
@@ -1694,7 +1694,7 @@ class dnszone(LDAPObject):
_validate_bind_forwarder,
cli_name='forwarder',
label=_('Zone forwarders'),
doc=_('A list of per-zone forwarders. A custom port can be specified '
doc=_('Per-zone forwarders. A custom port can be specified '
'for each forwarder using a standard format "IP_ADDRESS port PORT"'),
csv=True,
),
@@ -2929,8 +2929,8 @@ class dnsconfig(LDAPObject):
_validate_bind_forwarder,
cli_name='forwarder',
label=_('Global forwarders'),
doc=_('A list of global forwarders. A custom port can be specified ' \
'for each forwarder using a standard format "IP_ADDRESS port PORT"'),
doc=_('Global forwarders. A custom port can be specified for each '
'forwarder using a standard format "IP_ADDRESS port PORT"'),
csv=True,
),
StrEnum('idnsforwardpolicy?',

View File

@@ -167,7 +167,7 @@ api.register(group)
ipaexternalmember_param = Str('ipaexternalmember*',
cli_name='external',
label=_('External member'),
doc=_('comma-separated list of members of a trusted domain in DOM\\name or name@domain form'),
doc=_('Members of a trusted domain in DOM\\name or name@domain form'),
csv=True,
flags=['no_create', 'no_update', 'no_search'],
)

View File

@@ -516,7 +516,7 @@ class migrate_ds(Command):
Str('userobjectclass+',
cli_name='user_objectclass',
label=_('User object class'),
doc=_('Comma-separated list of objectclasses used to search for user entries in DS'),
doc=_('Objectclasses used to search for user entries in DS'),
csv=True,
default=(u'person',),
autofill=True,
@@ -524,7 +524,7 @@ class migrate_ds(Command):
Str('groupobjectclass+',
cli_name='group_objectclass',
label=_('Group object class'),
doc=_('Comma-separated list of objectclasses used to search for group entries in DS'),
doc=_('Objectclasses used to search for group entries in DS'),
csv=True,
default=(u'groupOfUniqueNames', u'groupOfNames'),
autofill=True,
@@ -532,7 +532,7 @@ class migrate_ds(Command):
Str('userignoreobjectclass*',
cli_name='user_ignore_objectclass',
label=_('Ignore user object class'),
doc=_('Comma-separated list of objectclasses to be ignored for user entries in DS'),
doc=_('Objectclasses to be ignored for user entries in DS'),
csv=True,
default=tuple(),
autofill=True,
@@ -540,7 +540,7 @@ class migrate_ds(Command):
Str('userignoreattribute*',
cli_name='user_ignore_attribute',
label=_('Ignore user attribute'),
doc=_('Comma-separated list of attributes to be ignored for user entries in DS'),
doc=_('Attributes to be ignored for user entries in DS'),
csv=True,
default=tuple(),
autofill=True,
@@ -548,7 +548,7 @@ class migrate_ds(Command):
Str('groupignoreobjectclass*',
cli_name='group_ignore_objectclass',
label=_('Ignore group object class'),
doc=_('Comma-separated list of objectclasses to be ignored for group entries in DS'),
doc=_('Objectclasses to be ignored for group entries in DS'),
csv=True,
default=tuple(),
autofill=True,
@@ -556,7 +556,7 @@ class migrate_ds(Command):
Str('groupignoreattribute*',
cli_name='group_ignore_attribute',
label=_('Ignore group attribute'),
doc=_('Comma-separated list of attributes to be ignored for group entries in DS'),
doc=_('Attributes to be ignored for group entries in DS'),
csv=True,
default=tuple(),
autofill=True,
@@ -612,7 +612,7 @@ class migrate_ds(Command):
),
)
exclude_doc = _('comma-separated list of %s to exclude from migration')
exclude_doc = _('%s to exclude from migration')
truncated_err_msg = _('''\
search results for objects to be migrated

View File

@@ -133,14 +133,14 @@ class permission(LDAPObject):
Str('permissions+',
cli_name='permissions',
label=_('Permissions'),
doc=_('Comma-separated list of permissions to grant ' \
doc=_('Permissions to grant ' \
'(read, write, add, delete, all)'),
csv=True,
),
Str('attrs*',
cli_name='attrs',
label=_('Attributes'),
doc=_('Comma-separated list of attributes'),
doc=_('Attributes to which the permission applies'),
csv=True,
normalizer=lambda value: value.lower(),
flags=('ask_create'),

View File

@@ -83,14 +83,13 @@ class selfservice(Object):
Str('permissions*',
cli_name='permissions',
label=_('Permissions'),
doc=_('Comma-separated list of permissions to grant ' \
'(read, write). Default is write.'),
doc=_('Permissions to grant (read, write). Default is write.'),
csv=True,
),
Str('attrs+',
cli_name='attrs',
label=_('Attributes'),
doc=_('Comma-separated list of attributes'),
doc=_('Attributes to which the permission applies.'),
csv=True,
normalizer=lambda value: value.lower(),
),