changeset 4372:61fb4061ff91

From coreutils. (xgetcwd): Include "xgetcwd.h". Improve comment.
author Jim Meyering <jim@meyering.net>
date Sat, 07 Jun 2003 10:07:29 +0000
parents 24b1449930dc
children 41b34c3271a8
files lib/xgetcwd.c
diffstat 1 files changed, 8 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lib/xgetcwd.c
+++ b/lib/xgetcwd.c
@@ -1,5 +1,5 @@
 /* xgetcwd.c -- return current directory with unlimited length
-   Copyright (C) 1992, 1996, 2000, 2001 Free Software Foundation, Inc.
+   Copyright (C) 1992, 1996, 2000, 2001, 2003 Free Software Foundation, Inc.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -46,12 +46,16 @@
 #endif
 
 #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 ()
+xgetcwd (void)
 {
 #if HAVE_GETCWD_NULL
   char *cwd = getcwd (NULL, 0);