request for review of exports.5 update

[Benjamin Kaduk]

Hi Rick,

On Mon, 11 Jul 2011, Rick Macklem wrote:

> Hi,
>
> I've added a few sentences to the exports.5 man page in an effort
> to try and clarify how NFSv4 exports work.
>
> If anyone would like to comment on these changes, it would be
> appreciated. Ideally, you are familiar with the FreeBSD /etc/exports
> file, but not w.r.t. NFSv4.
>
> The diff is at:
>  http://people.freebsd.org/~rmacklem/exports.5.diff
>
> in case you can't handle looking at the following. (The email
> system I use loves to mess with whitespace, etc.)
>
> Index: usr.sbin/mountd/exports.5
> ===================================================================
> --- usr.sbin/mountd/exports.5	(revision 223937)
> +++ usr.sbin/mountd/exports.5	(working copy)
> @@ -28,7 +28,7 @@
> .\"     @(#)exports.5	8.3 (Berkeley) 3/29/95
> .\" $FreeBSD$
> .\"
> -.Dd December 3, 2009
> +.Dd July 11, 2011
> .Dt EXPORTS 5
> .Os
> .Sh NAME
> @@ -72,6 +72,12 @@
> There are three forms of this specification.
> The first is to list all mount points as absolute
> directory paths separated by whitespace.
> +This list of directory paths should be considered an
> +``administrative control'', since it only enforced by the

This wants to be
=====
.Dq administrative control ,
since it is only enforced by the
=====
(note the "is" as well as the Dq macro)

> +.Xr mountd 8
> +daemon and not the kernel.
> +As such, it only applies to NFSv2, NFSv3 mounts and only w.r.t. the

The comma between v2 and v3 is not really right and should be replaced by 
"and"; the mdoc gurus seem to want to put the trailing "the" on the next
line in a case like this.

> +client's use of the mount protocol.
> The second is to specify the pathname of the root of the file system
> followed by the
> .Fl alldirs
> @@ -81,8 +87,19 @@
> .Fl r
> option is used on
> .Xr mountd 8 .
> +For NFSv4, since the ``administrative controls'' are not applied

The Dq macro should be used here as well.

> +because NFSv4 does not use the mount protocol,
> +all of the above export line(s) should be considered to have the
> +.Fl alldirs
> +flag, even if the line is specified without it.
> The third form has the string ``V4:'' followed by a single absolute path
> name, to specify the NFSv4 tree root.
> +This line does not export any file system, but simply marks where the root
> +of the server's directory tree is for NFSv4 clients.
> +The exported file systems for NFSv4 are specified via the other lines
> +in the
> +.Xr exports 5
> +file in the same way as for NFSv2, NFSv3.

I must confess that this chunk leaves me slightly confused.  Does the V4 
server export everything starting from the root of its export, or must 
subdirectories/filesystems be specified as well?

Thanks,

Ben Kaduk

> The pathnames must not have any symbolic links in them and should not have
> any
> .Dq Pa \&.
> _______________________________________________
> freebsd-fs at freebsd.org mailing list
> http://lists.freebsd.org/mailman/listinfo/freebsd-fs
> To unsubscribe, send any mail to "freebsd-fs-unsubscribe at freebsd.org"
>