[Bug libc/4368] New: bad documentation in stdlib.h

[Bug libc/4368] New: bad documentation in stdlib.h

[madcoder at debian dot org]

in stdlib.h we read:

/* Return the canonical absolute name of file NAME.  The last file name 
   component need not exist, and may be a symlink to a nonexistent file. 
   If RESOLVED is null, the result is malloc'd; otherwise, if the canonical 
   name is PATH_MAX chars or more, returns null with `errno' set to 
   ENAMETOOLONG; if the name fits in fewer than PATH_MAX chars, returns the 
   name in RESOLVED.  */ 
extern char *realpath (__const char *__restrict __name, 
                       char *__restrict __resolved) __THROW __wur; 



the part about "The last file name component need not exist, and may be a 
symlink to a nonexistent file" is wrong twice as:
 * it does not describe how the libc performs ;
 * it does not conforms to POSIX either.

I suggest this sentence to be removed from stdlib.h.

-- 
           Summary: bad documentation in stdlib.h
           Product: glibc
           Version: unspecified
            Status: NEW
          Severity: minor
          Priority: P2
         Component: libc
        AssignedTo: drepper at redhat dot com
        ReportedBy: madcoder at debian dot org
                CC: glibc-bugs at sources dot redhat dot com


http://sourceware.org/bugzilla/show_bug.cgi?id=4368

------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

[Bug libc/4368] bad documentation in stdlib.h

[drepper at redhat dot com]

------- Additional Comments From drepper at redhat dot com  2007-04-17 19:36 -------
I made a change in mainline.

-- 
           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED


http://sourceware.org/bugzilla/show_bug.cgi?id=4368

------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

[Bug libc/4368] bad documentation in stdlib.h

[cvs-commit at gcc dot gnu dot org]

------- Additional Comments From cvs-commit at gcc dot gnu dot org  2007-07-12 15:10 -------
Subject: Bug 4368

CVSROOT:	/cvs/glibc
Module name:	libc
Branch: 	glibc-2_5-branch
Changes by:	jakub@sourceware.org	2007-07-12 15:10:21

Modified files:
	.              : ChangeLog 
	stdlib         : stdlib.h 

Log message:
	2007-04-17  Ulrich Drepper  <drepper@redhat.com>
	
	[BZ #4368]
	* stdlib/stdlib.h: Remove obsolete part of comment for realpath.

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/libc/ChangeLog.diff?cvsroot=glibc&only_with_tag=glibc-2_5-branch&r1=1.10362.2.67&r2=1.10362.2.68
http://sourceware.org/cgi-bin/cvsweb.cgi/libc/stdlib/stdlib.h.diff?cvsroot=glibc&only_with_tag=glibc-2_5-branch&r1=1.114&r2=1.114.2.1



-- 


http://sourceware.org/bugzilla/show_bug.cgi?id=4368

------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.