git: df1817a81e89 - main - rc.conf.5: Improve documentation of <name>_oomprotect

From: Mateusz Piotrowski <0mp_at_FreeBSD.org>
Date: Thu, 07 Jul 2022 18:10:18 UTC
The branch main has been updated by 0mp (doc, ports committer):

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

commit df1817a81e891c4850157e7f21f94b113d663bec
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2022-07-07 18:01:57 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2022-07-07 18:09:17 +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
---
 share/man/man5/rc.conf.5 | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index 9c7af304b1f3..3c0bc297a8a0 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
@@ -221,6 +221,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
@@ -229,13 +230,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 -literal
-${name}_cmd
-.Ed
+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.