Bug 60068

Summary:	stat(2) man page does not mention sticky(8) man page
Product:	Documentation	Reporter:	kstailey <kstailey>
Component:	Books & Articles	Assignee:	Diomidis Spinellis <dds>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description kstailey 2003-12-09 13:00:36 UTC

The stat(2) manpage only has obsolete documention about the sticky bit.
There is not even a cross-reference to the sticky(8) man page.

Fix: 

At the least:

--- stat.2      14 Dec 2001 18:34:01 -0000      1.16.2.7
+++ stat.2      8 Dec 2003 13:44:55 -0000
@@ -188,7 +188,7 @@
 #define        S_IFWHT  0160000  /* whiteout */
 #define S_ISUID 0004000  /* set user id on execution */
 #define S_ISGID 0002000  /* set group id on execution */
-#define S_ISVTX 0001000  /* save swapped text even after use */
+#define S_ISVTX 0001000  /* save swapped text even after use; see sticky(8) */
 #define S_IRUSR 0000400  /* read permission, owner */
 #define S_IWUSR 0000200  /* write permission, owner */
 #define S_IXUSR 0000100  /* execute/search permission, owner */
@@ -255,6 +255,7 @@
 .Xr chmod 2 ,
 .Xr chown 2 ,
 .Xr utimes 2 ,
+.Xr sticky 8 ,
 .Xr symlink 7
 .Sh BUGS
 Applying
How-To-Repeat: "man 2 stat"

Comment 1 Diomidis Spinellis freebsd_committer

2003-12-10 15:16:32 UTC

Responsible Changed
From-To: freebsd-doc->dds

Got email from the submitter as last committer in the page.

Comment 2 Diomidis Spinellis freebsd_committer

2003-12-10 15:17:40 UTC

State Changed
From-To: open->patched

Added the suggested sticky(8) xref in -HEAD. 
Did not modify the suggested comment change to keep it in sync with the 
actual header file.

Comment 3 Diomidis Spinellis freebsd_committer

2003-12-25 22:30:17 UTC

State Changed
From-To: patched->closed

MFC change to RELENG_4 and no objection on the patch from the submitter.