git: e7b89962dc6d - stable/14 - login.conf(5): Document priority's default and possible values

From: Olivier Certner <olce_at_FreeBSD.org>
Date: Thu, 01 Feb 2024 21:31:16 UTC
The branch stable/14 has been updated by olce:

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

commit e7b89962dc6d26badc3d524235fd9bf29c1b44ac
Author:     Olivier Certner <olce@FreeBSD.org>
AuthorDate: 2023-06-21 08:39:15 +0000
Commit:     Olivier Certner <olce@FreeBSD.org>
CommitDate: 2024-02-01 21:29:41 +0000

    login.conf(5): Document priority's default and possible values
    
    Priority is reset to 0 if not explicitly specified.
    
    While here, be more explicit about what "Initial priority (nice) level"
    means and document that it is possible to set real-time or idle class'
    priorities with this capability.
    
    Reviewed by:            emaste
    Approved by:            emaste (mentor)
    MFC after:              3 days
    Sponsored by:           Kumacom SAS
    Differential Revision:  https://reviews.freebsd.org/D40689
    
    (cherry picked from commit aa96945e71b0f724e6ce673194d23f58d2d637d3)
    
    Approved by:            markj (mentor)
---
 lib/libutil/login.conf.5 | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/lib/libutil/login.conf.5 b/lib/libutil/login.conf.5
index 35ca11452811..4a98ee818139 100644
--- a/lib/libutil/login.conf.5
+++ b/lib/libutil/login.conf.5
@@ -247,7 +247,21 @@ for details.
 .It "nologin	file		If the file exists it will be displayed and"
 the login session will be terminated.
 .It "path	path	/bin /usr/bin	Default search path."
-.It "priority	number		Initial priority (nice) level."
+.It "priority	number	0	Initial priority level."
+A value in the nice range
+.Pq -20 to 20 included ,
+extended below with the 32 real-time class priorities
+.Po
+so -52 maps to priority 0 in the real-time class, -51 to 1, and so on until -21
+which maps to 31; see
+.Xr rtprio 1
+.Pc
+and above with the 32 idle class priorities
+.Po
+so 21 maps to priority 0 in the idle class, 22 to 1, and so on until 52 which
+maps to 31; see
+.Xr idprio 1
+.Pc .
 .It "requirehome 	bool	false	Require a valid home directory to login."
 .It "setenv	list		A comma-separated list of environment variables and"
 values to which they are to be set.