aboutsummaryrefslogtreecommitdiff
path: root/libiberty/getcwd.c
diff options
context:
space:
mode:
Diffstat (limited to 'libiberty/getcwd.c')
-rw-r--r--libiberty/getcwd.c24
1 files changed, 9 insertions, 15 deletions
diff --git a/libiberty/getcwd.c b/libiberty/getcwd.c
index 3445563..8c7c04c 100644
--- a/libiberty/getcwd.c
+++ b/libiberty/getcwd.c
@@ -2,24 +2,18 @@
This function is in the public domain. */
/*
-NAME
- getcwd -- get absolute pathname for current working directory
-SYNOPSIS
- char *getcwd (char pathname[len], len)
+@deftypefn Supplemental char* getcwd (char *@var{pathname}, @var{len})
-DESCRIPTION
- Copy the absolute pathname for the current working directory into
- the supplied buffer and return a pointer to the buffer. If the
- current directory's path doesn't fit in LEN characters, the result
- is NULL and errno is set.
+Copy the absolute pathname for the current working directory into
+@var{pathname}, which is assumed to point to a buffer of at least
+@var{len} bytes, and return a pointer to the buffer. If the current
+directory's path doesn't fit in @var{len} characters, the result is
+NULL and @var{errno} is set. If @var{pathname} is a null pointer,
+@code{getcwd} will obtain @var{len} bytes of space using
+@code{malloc}.
- If pathname is a null pointer, getcwd() will obtain size bytes of
- space using malloc.
-
-BUGS
- Emulated via the getwd() call, which is reasonable for most
- systems that do not have getcwd().
+@end deftypefn
*/