git: 62947ebdf7ba - stable/13 - freebsd-update.conf.5: Sort options

From: Mateusz Piotrowski <0mp_at_FreeBSD.org>
Date: Thu, 24 Feb 2022 13:48:18 UTC
The branch stable/13 has been updated by 0mp (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=62947ebdf7ba656eba2118087134e85133f0b489

commit 62947ebdf7ba656eba2118087134e85133f0b489
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2022-02-17 09:54:07 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2022-02-24 13:48:01 +0000

    freebsd-update.conf.5: Sort options
    
    Reported by:    pauamma_gundo.com
    MFC after:      1 week
    
    (cherry picked from commit bf8e97858365fe121968445c593dd4128d5f5490)
---
 share/man/man5/freebsd-update.conf.5 | 202 +++++++++++++++++------------------
 1 file changed, 101 insertions(+), 101 deletions(-)

diff --git a/share/man/man5/freebsd-update.conf.5 b/share/man/man5/freebsd-update.conf.5
index 76782dd1c095..f03cdb1e8b8f 100644
--- a/share/man/man5/freebsd-update.conf.5
+++ b/share/man/man5/freebsd-update.conf.5
@@ -48,80 +48,6 @@ error.
 .Pp
 The possible options and their meanings are as follows:
 .Bl -tag -width "BackupKernelSymbolFiles"
-.It Cm KeyPrint
-The single parameter following this keyword is the SHA256 hash
-of the RSA key which will be trusted to sign updates.
-.It Cm ServerName
-The single parameter following this keyword is the name of the
-server or server pool from which updates will be downloaded.
-.It Cm Components
-The parameters following this keyword are the components or
-sub-components of
-.Fx
-which will be updated.
-The components are
-.Dq src
-(source code),
-.Dq world
-(non-kernel binaries), and
-.Dq kernel ;
-the sub-components are the individual distribution sets generated as
-part of the release process (e.g.,
-.Dq src/base ,
-.Dq src/sys ,
-.Dq world/base ,
-.Dq world/catpages ,
-.Dq kernel/smp ) .
-Note that prior to
-.Fx 6.1 ,
-the
-.Dq kernel
-component was distributed as part of
-.Dq world/base .
-.Pp
-This option can be specified multiple times, and the parameters
-accumulate.
-.It Cm IgnorePaths
-The parameters following this keyword are regular expressions;
-updates to paths which start with a string matching one of
-these regular expressions will be ignored.
-.Pp
-This option can be specified multiple times, and the parameters
-accumulate.
-.It Cm IDSIgnorePaths
-The parameters following this keyword are regular expressions;
-paths which start with a string matching one of these regular
-expressions will be ignored by
-.Xr freebsd-update 8
-IDS.
-.Pp
-This option can be specified multiple times, and the parameters
-accumulate.
-.It Cm UpdateIfUnmodified
-The parameters following this keyword are regular expressions;
-updates to paths which start with a string matching one of
-these regular expressions will be ignored if the files have
-been modified locally (unless they are merged \(em see the
-.Cm MergeChanges
-option).
-.Pp
-This option can be specified multiple times, and the parameters
-accumulate.
-.It Cm MergeChanges
-The parameters following this keyword are regular expressions;
-updates to paths which start with a string matching one of
-these regular expressions will be merged with local modifications.
-.Pp
-This option can be specified multiple times, and the parameters
-accumulate.
-.It Cm WorkDir
-The single parameter following this keyword is the directory
-in which temporary files and downloaded updates will be stored.
-.It Cm MailTo
-The single parameter following this keyword is the address
-to which
-.Xr cron 8
-output will be mailed.
 .It Cm AllowAdd
 The single parameter following this keyword must be
 .Dq yes
@@ -146,33 +72,6 @@ and specifies whether
 .Xr freebsd-update 8
 is allowed to delete files, directories, and symlinks as
 part of updates downloaded.
-.It Cm KeepModifiedMetadata
-The single parameter following this keyword must be
-.Dq yes
-or
-.Dq no
-and specifies whether
-.Xr freebsd-update 8
-should keep existing file ownership, permissions, and flags
-when installing updates if these have been modified locally.
-.It Cm StrictComponents
-The single parameter following this keyword must be
-.Dq yes
-or
-.Dq no
-and specifies whether
-.Xr freebsd-update 8
-should interpret the list of components of
-.Fx
-specified via the
-.Cm Components
-option strictly as a list of components installed which
-should be upgraded when the
-.Cm upgrade
-command is used ("yes"), or merely as a list of components
-which might be installed, of which
-.Xr freebsd-update 8
-should identify which in fact are present ("no").
 .It Cm BackupKernel
 The single parameter following this keyword must be
 .Dq yes
@@ -221,6 +120,33 @@ backup kernel, the
 .Xr freebsd-update 8
 rollback command will recreate the symbol files along with the old
 kernel.
+.It Cm Components
+The parameters following this keyword are the components or
+sub-components of
+.Fx
+which will be updated.
+The components are
+.Dq src
+(source code),
+.Dq world
+(non-kernel binaries), and
+.Dq kernel ;
+the sub-components are the individual distribution sets generated as
+part of the release process (e.g.,
+.Dq src/base ,
+.Dq src/sys ,
+.Dq world/base ,
+.Dq world/catpages ,
+.Dq kernel/smp ) .
+Note that prior to
+.Fx 6.1 ,
+the
+.Dq kernel
+component was distributed as part of
+.Dq world/base .
+.Pp
+This option can be specified multiple times, and the parameters
+accumulate.
 .It Cm CreateBootEnv
 The single parameter following this keyword must be
 .Dq yes
@@ -275,6 +201,80 @@ or jail
 .Pq Fl j
 flags.
 .El
+.It Cm IDSIgnorePaths
+The parameters following this keyword are regular expressions;
+paths which start with a string matching one of these regular
+expressions will be ignored by
+.Xr freebsd-update 8
+IDS.
+.Pp
+This option can be specified multiple times, and the parameters
+accumulate.
+.It Cm IgnorePaths
+The parameters following this keyword are regular expressions;
+updates to paths which start with a string matching one of
+these regular expressions will be ignored.
+.Pp
+This option can be specified multiple times, and the parameters
+accumulate.
+.It Cm KeepModifiedMetadata
+The single parameter following this keyword must be
+.Dq yes
+or
+.Dq no
+and specifies whether
+.Xr freebsd-update 8
+should keep existing file ownership, permissions, and flags
+when installing updates if these have been modified locally.
+.It Cm KeyPrint
+The single parameter following this keyword is the SHA256 hash
+of the RSA key which will be trusted to sign updates.
+.It Cm MailTo
+The single parameter following this keyword is the address
+to which
+.Xr cron 8
+output will be mailed.
+.It Cm MergeChanges
+The parameters following this keyword are regular expressions;
+updates to paths which start with a string matching one of
+these regular expressions will be merged with local modifications.
+.Pp
+This option can be specified multiple times, and the parameters
+accumulate.
+.It Cm ServerName
+The single parameter following this keyword is the name of the
+server or server pool from which updates will be downloaded.
+.It Cm StrictComponents
+The single parameter following this keyword must be
+.Dq yes
+or
+.Dq no
+and specifies whether
+.Xr freebsd-update 8
+should interpret the list of components of
+.Fx
+specified via the
+.Cm Components
+option strictly as a list of components installed which
+should be upgraded when the
+.Cm upgrade
+command is used ("yes"), or merely as a list of components
+which might be installed, of which
+.Xr freebsd-update 8
+should identify which in fact are present ("no").
+.It Cm UpdateIfUnmodified
+The parameters following this keyword are regular expressions;
+updates to paths which start with a string matching one of
+these regular expressions will be ignored if the files have
+been modified locally (unless they are merged \(em see the
+.Cm MergeChanges
+option).
+.Pp
+This option can be specified multiple times, and the parameters
+accumulate.
+.It Cm WorkDir
+The single parameter following this keyword is the directory
+in which temporary files and downloaded updates will be stored.
 .El
 .Sh FILES
 .Bl -tag -width "/etc/freebsd-update.conf"