]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
Improve comment.
authorJim Meyering <jim@meyering.net>
Tue, 4 Mar 2003 18:07:59 +0000 (18:07 +0000)
committerJim Meyering <jim@meyering.net>
Tue, 4 Mar 2003 18:07:59 +0000 (18:07 +0000)
lib/xgetcwd.c

index c01491a483d50d2a9997b5d58af17414f8fb158b..ed425200d037ea1073af16d215bca5bd3a7c0224 100644 (file)
@@ -48,8 +48,11 @@ char *getwd ();
 #include "xalloc.h"
 #include "xgetcwd.h"
 
-/* Return the current directory, newly allocated, arbitrarily long.
-   Return NULL and set errno on error. */
+/* Return the current directory, newly allocated, assuming it fits
+   within PATH_MAX bytes -- this is a common system-imposed limit
+   on how getcwd works.
+   Upon an out-of-memory error, call xalloc_die.
+   Upon any other type of error, return NULL.  */
 
 char *
 xgetcwd (void)