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/basic | |
| 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/basic')
| -rw-r--r-- | doc/basic/date_format.rst | 2 | ||||
| -rw-r--r-- | doc/basic/stash_file_def.rst | 4 |
2 files changed, 5 insertions, 1 deletions
diff --git a/doc/basic/date_format.rst b/doc/basic/date_format.rst index bb89251444..f9460feb9b 100644 --- a/doc/basic/date_format.rst +++ b/doc/basic/date_format.rst @@ -23,6 +23,7 @@ Here *N* denotes a number, *d* - days, *h* - hours, *m* - minutes, *s* - seconds. .. note:: + The time interval should not exceed 2147483647 seconds. Examples:: @@ -133,6 +134,7 @@ Abbreviations used in this document | *z* : numeric time zone; .. note:: + - If the date specification contains spaces, you may need to enclose it in double quotes; - All keywords are case-insensitive. diff --git a/doc/basic/stash_file_def.rst b/doc/basic/stash_file_def.rst index cd6cca47b2..256e2c272d 100644 --- a/doc/basic/stash_file_def.rst +++ b/doc/basic/stash_file_def.rst @@ -17,7 +17,9 @@ The file should not be part of any backup of the machine, unless access to the backup data is secured as tightly as access to the master password itself. -.. note:: If you choose not to install a stash file, the KDC will prompt you for the master key each time it starts up. +.. note:: + + If you choose not to install a stash file, the KDC will prompt you for the master key each time it starts up. This means that the KDC will not be able to start automatically, such as after a system reboot. |