]> Savannah Git Hosting - gnulib.git/commitdiff
docs: mention why libgen.h is bad
authorEric Blake <eblake@redhat.com>
Mon, 22 Dec 2014 18:46:41 +0000 (11:46 -0700)
committerEric Blake <eblake@redhat.com>
Mon, 22 Dec 2014 18:50:37 +0000 (11:50 -0700)
I just debugged a failure in sharutils-4.14.2-1 for using basename()
without including <libgen.h>.  In the process, I realized that we
aren't doing a good job of explaining why we don't offer a libgen.h
replacement (it is useless because the only two functions it
provides are also useless).

* doc/posix-headers/libgen.texi (libgen.h): Refer to dirname module.

Signed-off-by: Eric Blake <eblake@redhat.com>
ChangeLog
doc/posix-headers/libgen.texi

index 3cf10e51e31d8761e1cc414aab8f9282a3f78f8a..75708b9396f54750b5ddf5adfe8c43595e55b0c1 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2014-12-22  Eric Blake  <eblake@redhat.com>
+
+       docs: mention why libgen.h is bad
+       * doc/posix-headers/libgen.texi (libgen.h): Refer to dirname module.
+
 2014-12-20  Paul Eggert  <eggert@cs.ucla.edu>
 
        assure: new module
index 7667cbbe90791f70d92602e521ea064412c9f031..40d70391ecd83ad267384f763f6d8057dd560fc1 100644 (file)
@@ -15,3 +15,6 @@ Portability problems not fixed by Gnulib:
 This header file is missing on some platforms:
 mingw, MSVC 9, BeOS.
 @end itemize
+
+The Gnulib module @code{dirname} provides similar API, with functions
+@code{base_name} and @code{dir_name} that also work with Windows file names.