krb5 commit: Standardize on commas after "e.g.", "i.e."
Benjamin Kaduk
kaduk at MIT.EDU
Thu Jul 12 14:57:46 EDT 2012
https://github.com/krb5/krb5/commit/2928f3d8bc7eeba62c7674a33ae8a482918568c1
commit 2928f3d8bc7eeba62c7674a33ae8a482918568c1
Author: Ben Kaduk <kaduk at mit.edu>
Date: Fri Jun 29 14:50:36 2012 -0400
Standardize on commas after "e.g.", "i.e."
It seems to be "more correct".
doc/rst_source/conf.py | 2 +-
doc/rst_source/krb_admins/conf_files/krb5_conf.rst | 2 +-
doc/rst_source/krb_admins/conf_ldap.rst | 2 +-
doc/rst_source/krb_admins/install_clients.rst | 2 +-
doc/rst_source/krb_admins/install_kdc.rst | 2 +-
doc/rst_source/krb_build/options2configure.rst | 16 ++++++++--------
doc/rst_source/krb_build/test_cov.rst | 2 +-
doc/rst_source/krb_plugindev/profile.rst | 2 +-
doc/rst_source/krb_users/user_commands/ksu.rst | 10 +++++-----
9 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/doc/rst_source/conf.py b/doc/rst_source/conf.py
index 655d3a9..c5534ab 100644
--- a/doc/rst_source/conf.py
+++ b/doc/rst_source/conf.py
@@ -164,7 +164,7 @@ html_show_sourcelink = False
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
-# This is the file name suffix for HTML files (e.g. ".xhtml").
+# This is the file name suffix for HTML files (e.g., ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
diff --git a/doc/rst_source/krb_admins/conf_files/krb5_conf.rst b/doc/rst_source/krb_admins/conf_files/krb5_conf.rst
index 7c52244..e375812 100644
--- a/doc/rst_source/krb_admins/conf_files/krb5_conf.rst
+++ b/doc/rst_source/krb_admins/conf_files/krb5_conf.rst
@@ -357,7 +357,7 @@ following tags may be specified in the realm's subsection:
principal should have. If this matches, then a string will be
formed from *string*, substituting the realm of the principal
for ``$0`` and the *n*'th component of the principal for
- ``$n`` (e.g. if the principal was ``johndoe/admin`` then
+ ``$n`` (e.g., if the principal was ``johndoe/admin`` then
``[2:$2$1foo]`` would result in the string
``adminjohndoefoo``). If this string matches *regexp*, then
the ``s//[g]`` substitution command will be run over the
diff --git a/doc/rst_source/krb_admins/conf_ldap.rst b/doc/rst_source/krb_admins/conf_ldap.rst
index 8fe4767..21cee6e 100644
--- a/doc/rst_source/krb_admins/conf_ldap.rst
+++ b/doc/rst_source/krb_admins/conf_ldap.rst
@@ -153,5 +153,5 @@ to the pre-existing *krbPrincipalName* value), and then add additional
Principal aliases are only returned by the KDC when the client
requests canonicalization. Canonicalization is normally requested for
service principals; for client principals, an explicit flag is often
-required (e.g. ``kinit -C``) and canonicalization is only performed
+required (e.g., ``kinit -C``) and canonicalization is only performed
for initial ticket requests.
diff --git a/doc/rst_source/krb_admins/install_clients.rst b/doc/rst_source/krb_admins/install_clients.rst
index 3100ff3..ec2cd81 100644
--- a/doc/rst_source/krb_admins/install_clients.rst
+++ b/doc/rst_source/krb_admins/install_clients.rst
@@ -36,7 +36,7 @@ through reverse address lookup. The default value of this flag is
true for historical reasons only.
If you anticipate users frequently logging into remote hosts
-(e.g. using ssh) using forwardable credentials, consider setting
+(e.g., using ssh) using forwardable credentials, consider setting
**forwardable** to true so that users obtain forwardable tickets by
default. Otherwise users will need to use ``kinit -f`` to get
forwardable tickets.
diff --git a/doc/rst_source/krb_admins/install_kdc.rst b/doc/rst_source/krb_admins/install_kdc.rst
index 92b46f9..4fb62f9 100644
--- a/doc/rst_source/krb_admins/install_kdc.rst
+++ b/doc/rst_source/krb_admins/install_kdc.rst
@@ -300,7 +300,7 @@ longer than 9 hours.
Add administrators to the Kerberos database
-------------------------------------------
-Next you need to add administrative principals (i.e. principals who
+Next you need to add administrative principals (i.e., principals who
are allowed to administer Kerberos database) to the Kerberos database.
You *must* add at least one principal now to allow communication
between the Kerberos administration daemon kadmind and the kadmin
diff --git a/doc/rst_source/krb_build/options2configure.rst b/doc/rst_source/krb_build/options2configure.rst
index 84f837c..b761d3e 100644
--- a/doc/rst_source/krb_build/options2configure.rst
+++ b/doc/rst_source/krb_build/options2configure.rst
@@ -100,7 +100,7 @@ Environment variables
Use *FLAGS* as the default set of C compiler flags.
**CPP=**\ *CPP*
- C preprocessor to use. (e.g. ``CPP='gcc -E'``)
+ C preprocessor to use. (e.g., ``CPP='gcc -E'``)
**CPPFLAGS=**\ *CPPOPTS*
Use *CPPOPTS* as the default set of C preprocessor flags. The
@@ -129,11 +129,11 @@ Environment variables
**LDFLAGS=**\ *LDOPTS*
This option informs the linker where to get additional libraries
- (e.g. ``-L<lib dir>``).
+ (e.g., ``-L<lib dir>``).
**LIBS=**\ *LDNAME*
This option allows one to specify libraries to be passed to the
- linker (e.g. ``-l<library>``)
+ linker (e.g., ``-l<library>``)
**SS_LIB=**\ *libs*...
If ``-lss`` is not the correct way to link in your installed ss
@@ -267,11 +267,11 @@ System types
**--build=**\ *BUILD*
Configure for building on *BUILD*
- (e.g. ``--build=x86_64-linux-gnu``).
+ (e.g., ``--build=x86_64-linux-gnu``).
**--host=**\ *HOST*
Cross-compile to build programs to run on *HOST*
- (e.g. ``--host=x86_64-linux-gnu``). By default, Kerberos V5
+ (e.g., ``--host=x86_64-linux-gnu``). By default, Kerberos V5
configuration will look for "build" option.
@@ -314,12 +314,12 @@ Optional packages
-----------------
**--with-**\ *PACKAGE*\ [=ARG\]
- Use *PACKAGE* (e.g. ``--with-imap``). The default value of *ARG*
+ Use *PACKAGE* (e.g., ``--with-imap``). The default value of *ARG*
is ``yes``.
**--without-**\ *PACKAGE*
Do not use *PACKAGE* (same as ``--with-PACKAGE=no``)
- (e.g. ``--without-libedit``).
+ (e.g., ``--without-libedit``).
**--with-size-optimizations**
Enable a few optimizations to reduce code size possibly at some
@@ -364,7 +364,7 @@ Optional packages
should return only vague error codes to clients.
**--with-crypto-impl=**\ *IMPL*
- Use specified crypto implementation (e.g. **--with-crypto=**\
+ Use specified crypto implementation (e.g., **--with-crypto=**\
*openssl*). Default is a native MIT Kerberos implementation
``builtin``. The other currently implemented crypto backends are
``openssl`` and ``nss``. (See :ref:`mitK5features`)
diff --git a/doc/rst_source/krb_build/test_cov.rst b/doc/rst_source/krb_build/test_cov.rst
index 673d65e..ccd6c13 100644
--- a/doc/rst_source/krb_build/test_cov.rst
+++ b/doc/rst_source/krb_build/test_cov.rst
@@ -2,7 +2,7 @@ Test coverage
=============
It is considered good practice to develop and maintain the test suite
-with high level of test coverage, i.e. the tests that execute every
+with high level of test coverage, i.e., the tests that execute every
single statement, every line of the code and then validate the result.
The GNU's gcov is a tool that analyses the frequency of execution of
diff --git a/doc/rst_source/krb_plugindev/profile.rst b/doc/rst_source/krb_plugindev/profile.rst
index 2670333..671d4c1 100644
--- a/doc/rst_source/krb_plugindev/profile.rst
+++ b/doc/rst_source/krb_plugindev/profile.rst
@@ -26,7 +26,7 @@ them.
A basic read-only profile module need only implement the
**get_values** and **free_values** methods. The **get_values** method
-accepts a null-terminated list of C string names (e.g. an array
+accepts a null-terminated list of C string names (e.g., an array
containing "libdefaults", "clockskew", and NULL for the **clockskew**
variable in the :ref:`libdefaults` section) and returns a
null-terminated list of values, which will be cleaned up with the
diff --git a/doc/rst_source/krb_users/user_commands/ksu.rst b/doc/rst_source/krb_users/user_commands/ksu.rst
index 2c2177a..5c548d1 100644
--- a/doc/rst_source/krb_users/user_commands/ksu.rst
+++ b/doc/rst_source/krb_users/user_commands/ksu.rst
@@ -36,7 +36,7 @@ the target user, and the other is to create a new security context.
.. note:: For the sake of clarity, all references to and attributes of
the user invoking the program will start with "source"
- (e.g. "source user", "source cache", etc.).
+ (e.g., "source user", "source cache", etc.).
Likewise, all references to and attributes of the target
account will start with "target".
@@ -47,12 +47,12 @@ AUTHENTICATION
To fulfill the first mission, ksu operates in two phases:
authentication and authorization. Resolving the target principal name
is the first step in authentication. The user can either specify his
-principal name with the **-n** option (e.g. ``-n jqpublic at USC.EDU``)
+principal name with the **-n** option (e.g., ``-n jqpublic at USC.EDU``)
or a default principal name will be assigned using a heuristic
described in the OPTIONS section (see **-n** option). The target user
name must be the first argument to ksu; if not specified root is the
default. If ``.`` is specified then the target user will be the
-source user (e.g. ``ksu .``). If the source user is root or the
+source user (e.g., ``ksu .``). If the source user is root or the
target user is the source user, no authentication or authorization
takes place. Otherwise, ksu looks for an appropriate Kerberos ticket
in the source cache.
@@ -211,7 +211,7 @@ OPTIONS
**-c** *source_cache_name*
- Specify source cache name (e.g. ``-c FILE:/tmp/my_cache``). If
+ Specify source cache name (e.g., ``-c FILE:/tmp/my_cache``). If
**-c** option is not used then the name is obtained from
**KRB5CCNAME** environment variable. If **KRB5CCNAME** is not
defined the source cache name is set to ``krb5cc_<source uid>``.
@@ -396,7 +396,7 @@ ksu should be owned by root and have the set user id bit turned on.
ksu attempts to get a ticket for the end server just as Kerberized
telnet and rlogin. Thus, there must be an entry for the server in the
-Kerberos database (e.g. ``host/nii.isi.edu at ISI.EDU``). The keytab
+Kerberos database (e.g., ``host/nii.isi.edu at ISI.EDU``). The keytab
file must be in an appropriate location.
More information about the cvs-krb5
mailing list