From d68a9cf4e9a5f8f37cdd31b59b4a4a552e1b6350 Mon Sep 17 00:00:00 2001 From: Jim Meyering Date: Tue, 4 Mar 2003 18:07:59 +0000 Subject: Improve comment. --- lib/xgetcwd.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'lib/xgetcwd.c') diff --git a/lib/xgetcwd.c b/lib/xgetcwd.c index c01491a48..ed425200d 100644 --- a/lib/xgetcwd.c +++ b/lib/xgetcwd.c @@ -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) -- cgit v1.2.3-54-g00ecf