git: 295934eaa92c - main - exports.5: Document the current behavior of -alldirs

From: Rick Macklem <rmacklem_at_FreeBSD.org>
Date: Sat, 28 Dec 2024 21:52:05 UTC
The branch main has been updated by rmacklem:

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

commit 295934eaa92cd917ae42a446899c0d527ad9c0c9
Author:     Rick Macklem <rmacklem@FreeBSD.org>
AuthorDate: 2024-12-28 21:51:08 +0000
Commit:     Rick Macklem <rmacklem@FreeBSD.org>
CommitDate: 2024-12-28 21:51:08 +0000

    exports.5: Document the current behavior of -alldirs
    
    Commit 07cd69e272da adds a new "-a" mountd option,
    which changes the behavior of mountd when file systems
    are exported via -alldirs.
    
    This patch updates the man page to reflect the actual
    behavior when -alldirs is used when mountd is started
    with/without -a.  Prior to the above commit, exports(5)
    documented that, when -alldirs was specified, the exports
    line would fail unless the directory was a server file
    system mount point.  This behavior was only documented
    in the Examples section and has not been implemented
    since a change between FreeBSD 1 and FreeBSD 2 was done.
    
    This is a contents change.
    
    PR:     282995
    Reviewed by:    markj
    MFC after:      2 weeks
    Differential Revision:  https://reviews.freebsd.org/D48139
---
 usr.sbin/mountd/exports.5 | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/usr.sbin/mountd/exports.5 b/usr.sbin/mountd/exports.5
index 6436e586cab9..a90d81c4db99 100644
--- a/usr.sbin/mountd/exports.5
+++ b/usr.sbin/mountd/exports.5
@@ -25,7 +25,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd October 08, 2024
+.Dd December 16, 2024
 .Dt EXPORTS 5
 .Os
 .Sh NAME
@@ -84,6 +84,15 @@ to limit exported directories to server local file system mount points.
 When exporting ZFS datasets with the
 .Sy sharenfs
 property, this is auomatically the case.
+If the
+.Fl alldirs
+flag is specified and
+the
+.Fl a
+command line option is specified for
+.Xr mountd 8 ,
+the export will fail if the directory path is not a local file system
+mount point.
 .Pp
 There are three forms of the directory path specification.
 The first is to list all mount points as absolute
@@ -550,12 +559,18 @@ will be exported read-only to the entire network 192.168.33.0/24, including
 all its subdirectories.
 Since
 .Pa /cdrom
-is the conventional mountpoint for a CD-ROM device, this export will
-fail if no CD-ROM medium is currently mounted there since that line
+is the conventional mountpoint for a CD-ROM device,
+for the case where the
+.Fl a
+option has been specified for
+.Xr mountd 8 ,
+this export will
+fail if no CD-ROM medium is currently mounted there
+since that line
 would then attempt to export a subdirectory of the root file system
 with the
 .Fl alldirs
-option which is not allowed.
+option.
 The
 .Fl quiet
 option will then suppress the error message for this condition that