Re: docs/168885: man page for find(1) fails to describe the -depth option

[Isabell Long-4]

Synopsis: man page for find(1) fails to describe the -depth option

State-Changed-From-To: open->feedback
State-Changed-By: issyl0
State-Changed-When: Sat Jun 9 11:04:27 UTC 2012
State-Changed-Why:
To submitter:

I'm not sure what exactly you mean.  This is the relevant
man page from 8.3 - the version of FreeBSD you reported to
be using - and the -d option is documented:

-d      Cause find to perform a depth-first traversal, i.e., directories
             are visited in post-order and all entries in a directory will be
             acted on before the directory itself.  By default, find visits
             directories in pre-order, i.e., before their contents.  Note, the
             default is not a breadth-first traversal.

             This option is equivalent to the -depth primary of IEEE Std
             1003.1-2001 (``POSIX.1'').  The -d option can be useful when find
             is used with cpio(1) to process files that are contained in
             directories with unusual permissions.  It ensures that you have
             write permission while you are placing files in a directory, then
             sets the directory's permissions as the last thing.
 
If you feel this could be clarified in some way, please let me know.

Thanks,

Isabell.



Responsible-Changed-From-To: freebsd-doc->issyl0
Responsible-Changed-By: issyl0
Responsible-Changed-When: Sat Jun 9 11:04:27 UTC 2012
Responsible-Changed-Why:
Taking this one.

http://www.freebsd.org/cgi/query-pr.cgi?pr=168885
_______________________________________________
[hidden email] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"

[Ronald F. Guilmette-2]

Regarding this PR:

http://www.freebsd.org/cgi/query-pr.cgi?pr=168885

I noticed after I had filed it that actually, the -d option for find(1) is
``documented'' (for some value of ``documented'') in _two_ different locations
within the find(1) man page, i.e. under the DESCRIPTION heading, and also under
the PRIMARIES heading.

In the first location, a full and complete description of the function of the
-d option is in fact given.  However in the second location, virtually nothing
is said about the functionality of -d, and there isn't even a reference
telling the reader to look for documentation of the -d option higher up
within the man page.
_______________________________________________
[hidden email] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"

[Ronald F. Guilmette-2]

In message <[hidden email]>, you wrote:

>Synopsis: man page for find(1) fails to describe the -depth option
>
>State-Changed-From-To: open->feedback
>State-Changed-By: issyl0
>State-Changed-When: Sat Jun 9 11:04:27 UTC 2012
>State-Changed-Why:
>To submitter:
>
>I'm not sure what exactly you mean.

I just now sent a follow-up, clarifying that the -d option is described in
_two_ different locations within the man page (only one of which is actually
complete).

I hope and trust that my follow-up/clarification has gone out to all of the
important/relevant people.  If not, please let me know and I will resend.


Regards,
rfg
_______________________________________________
[hidden email] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"

[Isabell Long-4]

On Sat, Jun 09, 2012 at 04:34:13AM -0700, Ronald F. Guilmette wrote:
> I just now sent a follow-up, clarifying that the -d option is described in
> _two_ different locations within the man page (only one of which is actually
> complete).
>
> I hope and trust that my follow-up/clarification has gone out to all of the
> important/relevant people.  If not, please let me know and I will resend.

It did reach us.  I'll take a closer look now.  :-)

Isabell.
_______________________________________________
[hidden email] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"