git: a848315f6804 - main - gmirror.8: Remove references rc.early

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

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

commit a848315f68047ae46a5d96cbc7a890e645ce646f
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2022-07-21 19:43:14 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2022-07-21 20:02:44 +0000

    gmirror.8: Remove references rc.early
    
    The manual page of gmirror describes how gmirror providers can be used
    for kernel dumps. Unfortunately, the instruction references
    /etc/rc.early, which is no longer a part of rc(8).
    
    Remove references to rc.early and suggest creating an rc(8) service
    script instead.
    
    Future work: In the Problem Report on Bugzilla, Lawrence Chen suggested
    adding example rc(8) scripts to the gmirror. However, those examples
    need to be tested before they become official reference examples in the
    base. Also, those scripts should probably land directly to /etc/rc.d,
    /usr/share/examples/rc.d, or /usr/share/examples/gmirror instead of the
    gmirror manual page.
    
    PR:             178818
    Reported by:    Lawrence Chen <beastie@tardisi.com>
    Fixes:          dd2b024a336f Removal of early.sh
    MFC after:      1 week
---
 lib/geom/mirror/gmirror.8 | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/lib/geom/mirror/gmirror.8 b/lib/geom/mirror/gmirror.8
index 128138bbd2e4..44ea08bcf65b 100644
--- a/lib/geom/mirror/gmirror.8
+++ b/lib/geom/mirror/gmirror.8
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 30, 2017
+.Dd July 21, 2022
 .Dt GMIRROR 8
 .Os
 .Sh NAME
@@ -388,21 +388,26 @@ Reading a dump from the mirror on boot will only work if the
 balance algorithm is used (that way
 .Nm
 will read only from the component with the highest priority).
-If you use a different balance algorithm, you should add:
+If you use a different balance algorithm, you should create an
+.Xr rc 8
+script that sets the balance algorithm to
+.Cm prefer ,
+for example with the following command:
 .Bd -literal -offset indent
 gmirror configure -b prefer data
 .Ed
 .Pp
-to the
-.Pa /etc/rc.early
-script and:
+Make sure that
+.Xr rcorder 8
+schedules the new script before
+.Xr savecore 8 .
+The desired balance algorithm can be restored later on
+by placing the following command in
+.Xr rc.local 8 :
 .Bd -literal -offset indent
 gmirror configure -b round-robin data
 .Ed
 .Pp
-to the
-.Pa /etc/rc.local
-script.
 The decision which component to choose for dumping is made when
 .Xr dumpon 8
 is called.