]> git.ipfire.org Git - thirdparty/krb5.git/commitdiff
Correct documentation of final profiles
authorMichael Mattioli <mmattioli@users.noreply.github.com>
Sun, 14 Jul 2019 21:35:17 +0000 (17:35 -0400)
committerGreg Hudson <ghudson@mit.edu>
Mon, 9 Dec 2019 22:02:52 +0000 (17:02 -0500)
The documentation for krb5.conf explaining final values is incorrect.
Only sections and subsections may usefully be marked as final, and
final designations only apply to later files, not to the same file.

[ghudson@mit.edu: corrected and shortened documentation; rewrote
commit message]

(cherry picked from commit 5105a91c9dc3210e242dff156b861e77aa80959a)

ticket: 8821
version_fixed: 1.17.1

doc/admin/conf_files/krb5_conf.rst

index 7b4389f6b8e8b856dd947d49d2a18a967ec0db82..4adb084a6a5e78e73b4ed30b389176fe03373d59 100644 (file)
@@ -35,17 +35,11 @@ or::
         baz = quux
     }
 
-Placing a '\*' at the end of a line indicates that this is the *final*
-value for the tag.  This means that neither the remainder of this
-configuration file nor any other configuration file will be checked
-for any other values for this tag.
-
-For example, if you have the following lines::
-
-    foo = bar*
-    foo = baz
-
-then the second value of ``foo`` (``baz``) would never be read.
+Placing a '\*' after the closing bracket of a section name indicates
+that the section is *final*, meaning that if the same section appears
+within a later file specified in **KRB5_CONFIG**, it will be ignored.
+A subsection can be marked as final by placing a '\*' after either the
+tag name or the closing brace.
 
 The krb5.conf file can include other files using either of the
 following directives at the beginning of a line::