summaryrefslogtreecommitdiff
path: root/lib/xgetcwd.c
diff options
context:
space:
mode:
authorJim Meyering <jim@meyering.net>2003-03-04 18:07:59 +0000
committerJim Meyering <jim@meyering.net>2003-03-04 18:07:59 +0000
commitd68a9cf4e9a5f8f37cdd31b59b4a4a552e1b6350 (patch)
tree0f45569fa0d8f1a6ad4ea9b90f450aaae3e4410a /lib/xgetcwd.c
parent59bd90b877043ae5025a758826eefe5840b7eae7 (diff)
downloadcoreutils-d68a9cf4e9a5f8f37cdd31b59b4a4a552e1b6350.tar.xz
Improve comment.
Diffstat (limited to 'lib/xgetcwd.c')
-rw-r--r--lib/xgetcwd.c7
1 files changed, 5 insertions, 2 deletions
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)