Bug 142815

Summary: [patch] namei(9) required include
Product: Documentation Reporter: Lachlan Kang <LCRTRIfFu91c710azO2Y>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Lachlan Kang 2010-01-14 05:10:00 UTC 
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.

Fix: Just add sys/fcntl.h as one of the required includes under SYNOPSIS.

Patch attached with submission follows:
How-To-Repeat: man 9 namei
Comment 1 dfilter service freebsd_committer freebsd_triage 2010-01-14 14:36:53 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"
Comment 2 John Baldwin freebsd_committer freebsd_triage 2010-01-14 15:03:37 UTC 
State Changed
From-To: open->closed

Fix committed, thanks!