On Thu, Aug 02, 2018 at 05:16:18PM +0200, Ingo Schwarze wrote:
> Hi,
>
> the first paragraph of the DESCRIPTION is all fluff.
> Let's just wipe it away completely, we always want
> the DESCRIPTION to be concise and get to the point.
>
> Instead, provide some real HISTORY.
>
> DESCRIPTION: minus five lines, same amount of information.
> HISTORY: plus three lines, but now containing some real data.
>
> OK?
> Ingo
>
ok by me. you might get away with removing the last sentence of BUGS
now, since HISTORY almost provides the same. while we're chopping, i'd
prefer to see the one line section that is CODE REFERENCES integrated
into DESCRIPTION.
jmc
>
> Index: namei.9
> ===================================================================
> RCS file: /cvs/src/share/man/man9/namei.9,v
> retrieving revision 1.18
> diff -u -r1.18 namei.9
> --- namei.9 23 Nov 2015 17:53:57 -0000 1.18
> +++ namei.9 2 Aug 2018 15:07:03 -0000
> @@ -57,20 +57,9 @@
> .Sh DESCRIPTION
> The
> .Fn namei
> -function is used to convert pathnames to file system vnodes.
> -The
> -name of the function is actually a contraction of the words
> -.Em name
> -and
> -.Em inode
> -for name-to-inode conversion, in the days before the
> -.Xr vfs 9
> -interface was implemented.
> -.Pp
> -The arguments passed to the functions are encapsulated in the
> -.Em nameidata
> -structure.
> -It has the following structure:
> +function converts a pathname to a
> +.Xr vnode 9 .
> +It uses the following structure:
> .Bd -literal
> struct nameidata {
> /*
> @@ -309,6 +298,16 @@
> .Xr vfs 9 ,
> .Xr vnode 9 ,
> .Xr VOP_LOOKUP 9
> +.Sh HISTORY
> +The
> +.Fn namei
> +function first appeared in
> +.At v4 .
> +Its name is an abbreviation for the name-to-inode conversion
> +which it performed before the appearance of
> +.Xr vfs 9
> +in
> +.Bx 4.3 Reno .
> .Sh BUGS
> It is unfortunate that much of the
> .Nm
>
