diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-11-28 14:19:43 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-12-10 13:01:07 -0500 |
| commit | 8bff1e50c28b6f11b771add7bd7d4a57419a567b (patch) | |
| tree | d61dd973acd51feb628120172de6882bcb34289d /doc/admin/conf_files | |
| parent | 4e0d270faad7fabd773cb159b8cb8e03adb19462 (diff) | |
| download | krb5-8bff1e50c28b6f11b771add7bd7d4a57419a567b.tar.gz krb5-8bff1e50c28b6f11b771add7bd7d4a57419a567b.tar.xz krb5-8bff1e50c28b6f11b771add7bd7d4a57419a567b.zip | |
Reformat RST to avoid sphinx warnings
Old versions of docutils will see inline markup (e.g., :ref:`foo`)
at the beginning of a line in the content of a directive block
and attempt to interpret that markup as options or arguments
to the directive. RST intended as inline markup (as opposed to
modifying the behavior of the directive) will not be interpretable
in this context, and causes Sphinx to emit a warning.
Work around this behavior by always leaving a blank line before
the content of a directive block, forcing it to be interpreted
as content and not options or arguments.
The buggy behavior was only encountered in note environments, but
for consistency of style, also reformat warning and error blocks.
Note the new style constraint in doc/README.
ticket: 7469 (new)
title: doc buildslave generates sphinx warnings
tags: pullup
target_version: 1.11
Diffstat (limited to 'doc/admin/conf_files')
| -rw-r--r-- | doc/admin/conf_files/kadm5_acl.rst | 5 | ||||
| -rw-r--r-- | doc/admin/conf_files/kdc_conf.rst | 4 | ||||
| -rw-r--r-- | doc/admin/conf_files/krb5_conf.rst | 4 |
3 files changed, 10 insertions, 3 deletions
diff --git a/doc/admin/conf_files/kadm5_acl.rst b/doc/admin/conf_files/kadm5_acl.rst index 4a8e0741e..ffebe90bb 100644 --- a/doc/admin/conf_files/kadm5_acl.rst +++ b/doc/admin/conf_files/kadm5_acl.rst @@ -25,7 +25,9 @@ ignored. Lines containing ACL entries have the format: principal permissions [target_principal [restrictions] ] -.. note:: Line order in the ACL file is important. The first matching entry +.. note:: + + Line order in the ACL file is important. The first matching entry will control access for an actor principal on a target principal. *principal* @@ -88,6 +90,7 @@ ignored. Lines containing ACL entries have the format: which is allowed due to that ACL line. .. warning:: + If the kadmind ACL file is modified, the kadmind daemon needs to be restarted for changes to take effect. diff --git a/doc/admin/conf_files/kdc_conf.rst b/doc/admin/conf_files/kdc_conf.rst index 4da8d936f..763143105 100644 --- a/doc/admin/conf_files/kdc_conf.rst +++ b/doc/admin/conf_files/kdc_conf.rst @@ -491,7 +491,9 @@ administrative server will be appended to the file PKINIT options -------------- -.. note:: The following are pkinit-specific options. These values may +.. note:: + + The following are pkinit-specific options. These values may be specified in [kdcdefaults] as global defaults, or within a realm-specific subsection of [realms]. Also note that a realm-specific value over-rides, does not add to, a generic diff --git a/doc/admin/conf_files/krb5_conf.rst b/doc/admin/conf_files/krb5_conf.rst index 5dbbfa49b..6911f5c69 100644 --- a/doc/admin/conf_files/krb5_conf.rst +++ b/doc/admin/conf_files/krb5_conf.rst @@ -724,7 +724,9 @@ built-in modules exist for these interfaces: PKINIT options -------------- -.. note:: The following are PKINIT-specific options. These values may +.. note:: + + The following are PKINIT-specific options. These values may be specified in [libdefaults] as global defaults, or within a realm-specific subsection of [libdefaults], or may be specified as realm-specific values in the [realms] section. |