From nobody@FreeBSD.org  Thu Jan 14 05:08:41 2010
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 5958E106566B
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 14 Jan 2010 05:08:41 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id 132438FC08
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 14 Jan 2010 05:08:41 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id o0E58ebS020683
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 14 Jan 2010 05:08:40 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id o0E58euf020676;
	Thu, 14 Jan 2010 05:08:40 GMT
	(envelope-from nobody)
Message-Id: <201001140508.o0E58euf020676@www.freebsd.org>
Date: Thu, 14 Jan 2010 05:08:40 GMT
From: Lachlan Kang <LCRTRIfFu91c710azO2Y@live.co.uk>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] namei(9) required include
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         142815
>Category:       docs
>Synopsis:       [patch] namei(9) required include
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Jan 14 05:10:00 UTC 2010
>Closed-Date:    Thu Jan 14 15:04:38 UTC 2010
>Last-Modified:  Thu Jan 14 15:04:38 UTC 2010
>Originator:     Lachlan Kang
>Release:        FreeBSD 8.0-RELEASE
>Organization:
>Environment:
>Description:
namei(9) should specify under SYNOPSIS that sys/fcntl.h needs to be included.
The macro NDINIT which is described in namei(9), uses the value AT_FDCWD, which is defined in sys/fcntl.h.
If a program that uses NDINIT() is written and it does not include sys/fcntl.h, then it will not be able to compile.
>How-To-Repeat:
man 9 namei
>Fix:
Just add sys/fcntl.h as one of the required includes under SYNOPSIS.

Patch attached with submission follows:

Index: head/share/man/man9/namei.9
===================================================================
--- head/share/man/man9/namei.9	(revision 202273)
+++ head/share/man/man9/namei.9	(working copy)
@@ -46,6 +46,7 @@
 .In sys/param.h
 .In sys/proc.h
 .In sys/namei.h
+.In sys/fcntl.h
 .Ft int
 .Fn namei "struct nameidata *ndp"
 .Ft void


>Release-Note:
>Audit-Trail:

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/142815: commit references a PR
Date: Thu, 14 Jan 2010 14:36:53 +0000 (UTC)

 Author: jhb
 Date: Thu Jan 14 14:36:39 2010
 New Revision: 202284
 URL: http://svn.freebsd.org/changeset/base/202284
 
 Log:
   - Update required headers for namei() to add <sys/fcntl.h> and remove
     <sys/proc.h>.
   - Add RETURN VALUES and ERROR sections for namei()'s error return values.
   - Add a missing link to NDHASGIANT.9.
   
   PR:		docs/142815, docs/142816
   Submitted by:	Lachlan Kang (1, 2)
   MFC after:	3 days
 
 Modified:
   head/share/man/man9/Makefile
   head/share/man/man9/namei.9
 
 Modified: head/share/man/man9/Makefile
 ==============================================================================
 --- head/share/man/man9/Makefile	Thu Jan 14 14:30:54 2010	(r202283)
 +++ head/share/man/man9/Makefile	Thu Jan 14 14:36:39 2010	(r202284)
 @@ -903,7 +903,8 @@ MLINKS+=mutex.9 mtx_assert.9 \
  	mutex.9 mtx_unlock_spin.9 \
  	mutex.9 mtx_unlock_spin_flags.9
  MLINKS+=namei.9 NDFREE.9 \
 -	namei.9 NDINIT.9
 +	namei.9 NDINIT.9 \
 +	namei.9 NDHASGIANT.9
  MLINKS+=pbuf.9 getpbuf.9 \
  	pbuf.9 relpbuf.9 \
  	pbuf.9 trypbuf.9
 
 Modified: head/share/man/man9/namei.9
 ==============================================================================
 --- head/share/man/man9/namei.9	Thu Jan 14 14:30:54 2010	(r202283)
 +++ head/share/man/man9/namei.9	Thu Jan 14 14:36:39 2010	(r202284)
 @@ -44,7 +44,7 @@
  .Nd pathname translation and lookup operations
  .Sh SYNOPSIS
  .In sys/param.h
 -.In sys/proc.h
 +.In sys/fcntl.h
  .In sys/namei.h
  .Ft int
  .Fn namei "struct nameidata *ndp"
 @@ -315,6 +315,34 @@ flag can be passed to the
  .Fn NDFREE
  function.
  .El
 +.Sh RETURN VALUES
 +If successful,
 +.Fn namei
 +will return 0, otherwise it will return an error.
 +.Sh ERRORS
 +Errors which
 +.Fn namei
 +may return:
 +.Bl -tag -width Er
 +.It Bq Er ENOTDIR
 +A component of the specified pathname is not a directory when a directory is
 +expected.
 +.It Bq Er ENAMETOOLONG
 +A component of a pathname exceeded 255 characters,
 +or an entire pathname exceeded 1023 characters.
 +.It Bq Er ENOENT
 +A component of the specified pathname does not exist,
 +or the pathname is an empty string.
 +.It Bq Er ACCES
 +An attempt is made to access a file in a way forbidden by its file access
 +permissions.
 +.It Bq Er ELOOP
 +Too many symbolic links were encountered in translating the pathname.
 +.It Bq Er EISDIR
 +An attempt is made to open a directory with write mode specified.
 +.It Bq Er EROFS
 +An attempt is made to modify a file or directory on a read-only file system.
 +.El
  .Sh FILES
  .Bl -tag
  .It Pa src/sys/kern/vfs_lookup.c
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->closed 
State-Changed-By: jhb 
State-Changed-When: Thu Jan 14 15:03:37 UTC 2010 
State-Changed-Why:  
Fix committed, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=142815 
>Unformatted:
