Bug 32431

Summary: New section 9 manual pages
Product: Documentation Reporter: davidc <davidc>
Component: Books & ArticlesAssignee: Alfred Perlstein <alfred>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
pages.tgz none

Description davidc 2001-12-01 23:40:00 UTC 
	A number of new section 9 manual pages.  Any comments
	related to technical details and page format are welcome.

	As well, any comments on how to make the entire section
	9 manual pages more useful are very welcome!
Comment 1 Alfred Perlstein freebsd_committer freebsd_triage 2001-12-02 01:54:45 UTC 
Responsible Changed
From-To: freebsd-doc->alfred

I'll take care of this, I have some feedback for Chad that I need him 
to address before these can be committed.
Comment 2 Alfred Perlstein freebsd_committer freebsd_triage 2001-12-02 02:13:46 UTC 
State Changed
From-To: open->feedback

I need several of the included manpages cleaned up and fleshed out 
before they will be included in the system: 

vfs_getnewfsid.9: 

The vfs_getnewfsid() function allocates a new filesystem identifier for 
the mount point given. 
ok, why would one do this? 

The actual fsid is made up of two 32 bit integers.  The first is unique 
in the set of mounted filesystems, while the second holds the filesystem 
type. 
since the function returns void, where is this stored? 

what other functions use this fsid and why? 

vfs_getvfs.9: 
The vfs_getvfs() function returns the mount point structure for a 
filesystem given its filesystem identifier. 
Where, when and how does one aquire a fsid_t *fsid? 

vfs_mountedon.9:  
The vfs_mountedon() function checks a vnode for a valid mount point 
structure, and returns that the vnode is busy if it does have a valid 
mount point. 
?? 
Needs rewording, perhaps: 
The vfs_mountedon() function returns EBUSY if the passed vnode is 
currently in use as a mount point. 
?? 

vfs_mountedon.9: 
The vfs_mountedon() function checks a vnode for a valid mount point 
structure, and returns that the vnode is busy if it does have a valid 
mount point. 
This is pretty vauge and doesn't make sense to me, upon investigation 
it seems that what vfs_mountedon(9) does is check whether a device 
vnode is busy in the sense that it has a filesystem mounted on top of 
it. 
can you reword this to something like my description? 

vfs_rootmountalloc: 
The vfs_rootmountalloc() function allocates a mount structure initialized 
from the vfsconf type that matches fstypename. 
er, ok, why?  What does this mean?  What's a vfsconf type?  Does it need 
a manpage? 

I think we need to get Chad a commit bit so he can do these at his  
leasure. :)
Comment 3 Alfred Perlstein freebsd_committer freebsd_triage 2001-12-03 00:25:21 UTC 
State Changed
From-To: feedback->closed

Chad did an excellent job addressing my requests for additional 
clarification in the submitted documentation, it has been integrated.