Bug 108142

Summary: [patch] extattr(2) man page incomplete for extattr_list_*()
Product: Documentation Reporter: Richard Dawe <rich>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Richard Dawe 2007-01-20 09:40:17 UTC 
The man page for extattr(2) does not describe the extattr_list_file() or extattr_list_fd() functions fully. Specifically:

* It is not described what happens when data == NULL.
* They are not mentioned in the RETURN VALUES section.
* They are not mentioned in the ERRORS section.

Fix: Browsing the source tree (src/sys/ufs/ufs/ufs_extattr.c, src/sys/kern/vfs_syscalls.c) shows that extattr_list_*() return the size when data == NULL, as with extattr_get_*(). I tested and used this when porting File::ExtAttr <http://search.cpan.org/dist/File-ExtAttr/> to FreeBSD, so it works in practice. ;)

I've attached a patch to the extattr(2) man page to fix these issues.

Patch attached with submission follows:
Comment 1 dfilter service freebsd_committer freebsd_triage 2008-01-29 18:15:45 UTC 
trhodes     2008-01-29 18:15:38 UTC

  FreeBSD src repository

  Modified files:
    lib/libc/sys         extattr_get_file.2 
  Log:
  Update this manual page to describe the extattr_list_file() and the
  extattr_list_fd() functions.
  
  PR:             108142
  Submitted by:   Richard Dawe <rich@phekda.gotadsl.co.uk>
  Reviewed by:    kientzle
  
  Revision  Changes    Path
  1.19      +13 -6     src/lib/libc/sys/extattr_get_file.2
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2008-01-29 18:15:58 UTC 
State Changed
From-To: open->patched

Patched in HEAD, thanks for the submission!
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2008-01-29 18:15:58 UTC 
Responsible Changed
From-To: freebsd-doc->trhodes

Over to me, MFC reminder.
Comment 4 dfilter service freebsd_committer freebsd_triage 2008-08-03 20:00:27 UTC 
trhodes     2008-08-03 18:59:56 UTC

  FreeBSD src repository

  Modified files:        (Branch: RELENG_7)
    lib/libc/sys         extattr_get_file.2 
  Log:
  SVN rev 181259 on 2008-08-03 18:59:56Z by trhodes
  
  MFC r175798:
  
  Update this manual page to describe the extattr_list_file() and the
  extattr_list_fd() functions.
  
  PR:             108142
  Submitted by:   Richard Dawe <rich@phekda.gotadsl.co.uk>
  Reviewed by:    kientzle
  
  Revision  Changes    Path
  1.18.2.1  +13 -6     src/lib/libc/sys/extattr_get_file.2
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 5 dfilter service freebsd_committer freebsd_triage 2008-08-28 01:28:53 UTC 
trhodes     2008-08-28 00:28:29 UTC

  FreeBSD src repository

  Modified files:        (Branch: RELENG_6)
    lib/libc/sys         extattr_get_file.2 
  Log:
  SVN rev 182313 on 2008-08-28 00:28:29Z by trhodes
  
  MFC r175798:
  
  Update this manual page to describe the extattr_list_file() and the
  extattr_list_fd() functions.
  
  PR:             108142
  Submitted by:   Richard Dawe <rich@phekda.gotadsl.co.uk>
  Reviewed by:    kientzle
  
  Revision  Changes    Path
  1.17.2.1  +13 -6     src/lib/libc/sys/extattr_get_file.2
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2008-08-28 01:28:57 UTC 
State Changed
From-To: patched->closed

Final merge completed, thanks for the submission!