Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 22 Jul 2022 00:28:00 GMT
From:      Mateusz Piotrowski <0mp@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org
Subject:   git: 57df44b2c129 - stable/12 - rc.conf.5: Improve documentation of <name>_oomprotect
Message-ID:  <202207220028.26M0S0sL076593@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch stable/12 has been updated by 0mp (doc, ports committer):

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

commit 57df44b2c129fbd652aaf15d071493ed5698167b
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2022-07-07 18:01:57 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2022-07-22 00:26:28 +0000

    rc.conf.5: Improve documentation of <name>_oomprotect
    
    Apart from improving readability, this commit mentions that
    <name>_oomprotect is ignored in a jail environment. Also, replace
    ${name}_cmd with the correct ${argument}_cmd and point the reader to
    rc.subr(8).
    
    MFC after:      1 week
    
    (cherry picked from commit df1817a81e891c4850157e7f21f94b113d663bec)
---
 share/man/man5/rc.conf.5 | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index fcc8ee5a4a89..e11b25bcd651 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 28, 2022
+.Dd July 7, 2022
 .Dt RC.CONF 5
 .Os
 .Sh NAME
@@ -216,6 +216,7 @@ The
 .Xr nice 1
 value to run the service under.
 .It Ao Ar name Ac Ns Va _oomprotect
+.Pq Vt str
 Use
 .Xr protect 1
 to prevent the service from being killed when swap space
@@ -224,13 +225,15 @@ Use
 .Dq Li YES
 to protect only the service itself, and
 .Dq Li ALL
-to protect the service and all child processes.
+to protect the service and all its child processes.
 .Pp
-Please note rc scripts that redefine
-.Bd
-${name}_cmd
-.Ed
-such as PostgreSQL will not a inherit the OOM killer protection.
+Please note that rc scripts which redefine
+.Dl ${argument}_cmd
+.Pq see Xr rc.subr 8
+such as PostgreSQL will not inherit the OOM killer protection.
+.Pp
+This variable has no effect on services running within a
+.Xr jail 8 .
 .It Ao Ar name Ac Ns Va _user
 .Pq Vt str
 Run the service under this user account.



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202207220028.26M0S0sL076593>