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/appdev | |
| 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/appdev')
| -rw-r--r-- | doc/appdev/gssapi.rst | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/appdev/gssapi.rst b/doc/appdev/gssapi.rst index 29c06b565c..a8c731bd7b 100644 --- a/doc/appdev/gssapi.rst +++ b/doc/appdev/gssapi.rst @@ -145,16 +145,22 @@ the default keytab. If the input name contains both a *service* and a *hostname*, clients will be allowed to authenticate to any host-based principal for the named service and hostname, regardless of realm. -.. note:: If a *hostname* is specified, it will be canonicalized +.. note:: + + If a *hostname* is specified, it will be canonicalized using forward name resolution, and possibly also using reverse name resolution depending on the value of the **rdns** variable in :ref:`libdefaults`. -.. note:: If the **ignore_acceptor_hostname** variable in +.. note:: + + If the **ignore_acceptor_hostname** variable in :ref:`libdefaults` is enabled, then *hostname* will be ignored even if one is specified in the input name. -.. note:: In MIT krb5 versions prior to 1.10, and in Heimdal's +.. note:: + + In MIT krb5 versions prior to 1.10, and in Heimdal's implementation of the krb5 mechanism, an input name with just a *service* is treated like an input name of ``service@localhostname``, where *localhostname* is the |