From 4d0e739345fe3039db16e0ee613431e1aa92cf02 Mon Sep 17 00:00:00 2001 From: Rob Crittenden Date: Fri, 4 Mar 2011 11:08:54 -0500 Subject: Fix style and grammatical issues in built-in command help. There is a rather large API.txt change but it is only due to changes in the doc string in parameters. ticket 729 --- ipalib/plugins/config.py | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) (limited to 'ipalib/plugins/config.py') diff --git a/ipalib/plugins/config.py b/ipalib/plugins/config.py index 1b5fe869f..9d55f95e3 100644 --- a/ipalib/plugins/config.py +++ b/ipalib/plugins/config.py @@ -20,7 +20,7 @@ """ Manage the IPA configuration -Manage the default values tha IPA uses and some of its tuning parameters. +Manage the default values that IPA uses and some of its tuning parameters. To show the current configuration: ipa config-show @@ -32,12 +32,12 @@ The available options are: User management options: - --maxusername=INT Max username length when creating/modifing a user + --maxusername=INT Max. username length when creating/modifying a user --homedirectory=STR Default location of home directories (default /home) --defaultshell=STR Default shell for new users (default /bin/sh) --defaultgroup=STR Default group for new users (default ipausers). The - group must exist. Otherwise adding new users will fail. - --emaildomain=STR Default e-mail domain new users + group must exist, or adding new users will fail. + --emaildomain=STR Default e-mail domain for new users Search tuning options. These impact how much data is searched through and how many records may be returned on a given search. @@ -55,12 +55,12 @@ The password notification value is stored here so it will be replicated. It is not currently used to notify users in advance of an expiring password. -Some attributes are read-only, provided for information purposes. These +Some attributes are read-only, provided only for information purposes. These include: Certificate Subject base: the configured certificate subject base, e.g. O=EXAMPLE.COM. This is configurable only at install time. -Password plugin features: currently defines additional hashes that the +Password plug-in features: currently defines additional hashes that the password will generate (there may be other conditions). """ @@ -93,82 +93,82 @@ class config(LDAPObject): takes_params = ( Int('ipamaxusernamelength?', cli_name='maxusername', - label=_('Max username length'), + label=_('Max. username length'), minvalue=1, ), IA5Str('ipahomesrootdir?', cli_name='homedirectory', label=_('Home directory base'), - doc=_('Default location of home directories'), + doc=_('Default location of home directories.'), ), Str('ipadefaultloginshell?', cli_name='defaultshell', label=_('Default shell'), - doc=_('Default shell for new users'), + doc=_('Default shell for new users.'), ), Str('ipadefaultprimarygroup?', cli_name='defaultgroup', label=_('Default users group'), - doc=_('Default group for new users'), + doc=_('Default group for new users.'), ), Str('ipadefaultemaildomain?', cli_name='emaildomain', - label=_('Default e-mail domain'), - doc=_('Default e-mail domain new users'), + label=_('Default e-mail domain for new users'), + doc=_('Default e-mail domain new users.'), ), Int('ipasearchtimelimit?', validate_searchtimelimit, cli_name='searchtimelimit', label=_('Search time limit'), - doc=_('Max. amount of time (sec.) for a search (> 0, or -1 for unlimited)'), + doc=_('Max. amount of time (sec.) for a search (> 0, or -1 for unlimited).'), minvalue=-1, ), Int('ipasearchrecordslimit?', cli_name='searchrecordslimit', label=_('Search size limit'), - doc=_('Max. number of records to search (-1 is unlimited)'), + doc=_('Max. number of records to search (-1 is unlimited).'), minvalue=-1, ), IA5Str('ipausersearchfields?', cli_name='usersearch', label=_('User search fields'), - doc=_('A comma-separated list of fields to search when searching for users'), + doc=_('A comma-separated list of fields to search when searching for users.'), ), IA5Str('ipagroupsearchfields?', cli_name='groupsearch', label='Group search fields', - doc=_('A comma-separated list of fields to search when searching for groups'), + doc=_('A comma-separated list of fields to search when searching for groups.'), ), Bool('ipamigrationenabled?', cli_name='enable_migration', label=_('Migration mode'), - doc=_('Enable migration mode'), + doc=_('Enable migration mode.'), ), Str('ipacertificatesubjectbase?', cli_name='subject', label=_('Certificate Subject base'), - doc=_('Base for certificate subjects (OU=Test,O=Example)'), + doc=_('Base for certificate subjects (OU=Test,O=Example).'), flags=['no_update'], ), List('ipagroupobjectclasses?', cli_name='groupobjectclasses', label=_('Default group objectclasses'), - doc=_('Default group objectclassses (comma-separated list)'), + doc=_('Default group objectclassses (comma-separated list).'), ), List('ipauserobjectclasses?', cli_name='userobjectclasses', label=_('Default user objectclasses'), - doc=_('Default user objectclassses (comma-separated list)'), + doc=_('Default user objectclassses (comma-separated list).'), ), Int('ipapwdexpadvnotify?', cli_name='pwdexpnotify', label=_('Password Expiration Notification'), - doc=_('Password Expiration Notification (days)'), + doc=_('Number of days\'s notice of impending password expiration.'), minvalue=0, ), Str('ipaconfigstring?', cli_name='ipaconfigstring', label=_('Password plugin features'), - doc=_('Extra hashes to generate in password plugin'), + doc=_('Extra hashes to generate in password plug-in.'), flags=['no_update'], ), ) -- cgit