git: 5a20fcd199ba - stable/13 - growfs(7): clarify assumptions and limitations

The branch stable/13 has been updated by karels:

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

commit 5a20fcd199ba4b5290e3d7c01722459a3ab2d450
Author:     Mike Karels <karels@FreeBSD.org>
AuthorDate: 2023-01-05 13:15:21 +0000
Commit:     Mike Karels <karels@FreeBSD.org>
CommitDate: 2023-01-13 19:15:58 +0000

    growfs(7): clarify assumptions and limitations
    
    Document that the growfs(7) script works only if the root file system
    is in the last partition and free space immediately follows it.
    Don't imply that /usr can be a separate partition, as that would
    likely mean that root is not last.
    
    Reported by:    marklmi at yahoo dot com
    
    (cherry picked from commit 8664e266d6a4573d1875ee8f4ce0cdb091171780)
---
 share/man/man7/growfs.7 | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/share/man/man7/growfs.7 b/share/man/man7/growfs.7
index 0ebc5b6f3ee0..41903023af91 100644
--- a/share/man/man7/growfs.7
+++ b/share/man/man7/growfs.7
@@ -36,6 +36,7 @@ The
 .Nm
 script normally runs at the first boot after system installation.
 If the boot disk is larger than the root file system and boot partitions,
+and the root file system is in the last partition,
 .Nm
 can expand the root file system.
 It can also add a swap partition, with a default size of 10% of the boot disk.
@@ -99,12 +100,17 @@ partition before this procedure
 in order to expand the root file system to the new size.
 A new swap partition can be created during the expansion.
 .Sh IMPLEMENTATION NOTES
+The
+.Nm
+script only attempts to expand the root file system,
+and free space must be available immediately after the root partition.
+It is normally used on images that have a single file system.
 The script requires that
-.Pa awk
+.Xr awk 1
 be present and in the path.
 This usually means that
 .Pa /usr
-should be mounted prior to running the script.
+must be available prior to running the script.
 .Sh FILES
 .Bl -tag -compact -width Pa
 .It Pa /etc/fstab
@@ -114,7 +120,9 @@ should be mounted prior to running the script.
 .Ex -std
 .Sh SEE ALSO
 .Xr fstab 5 ,
-.Xr rc.conf 5
+.Xr rc.conf 5 ,
+.Xr growfs 8 ,
+.Xr zpool 8
 .Sh HISTORY
 The
 .Nm