bug-gnulib
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: `base_name' and `dir_name' not documented


From: Ben Pfaff
Subject: Re: `base_name' and `dir_name' not documented
Date: Sun, 28 Sep 2014 09:53:09 -0700
User-agent: Mutt/1.5.23 (2014-03-12)

On Sun, Sep 21, 2014 at 04:43:07PM +0200, Werner LEMBERG wrote:
> 
> The functions `base_name' and `dir_name' (or rather `mdir_name'),
> intended as replacements for `basename' and `dirname' that work on
> Windows also, are not documented in `gnulib.pdf'.  I suggest to
> mention those two function names at least in `modules/dirname'.

I applied the following.  I hope that it helps.

--8<--------------------------cut here-------------------------->8--

From: Ben Pfaff <address@hidden>
Date: Sun, 28 Sep 2014 09:52:08 -0700
Subject: [PATCH] basename, dirname: Improve documentation.

* doc/posix-functions/basename.texi: Mention dirname module and
base_name() function.
* doc/posix-functions/dirname.texi: Mention dir_name() and
mdir_name() functions.

Suggested by Werner LEMBERG <address@hidden>.
---
 ChangeLog                         | 9 +++++++++
 doc/posix-functions/basename.texi | 3 +++
 doc/posix-functions/dirname.texi  | 5 +++--
 3 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 876174f..0bf83d4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2014-09-28  Ben Pfaff  <address@hidden>
+
+       basename, dirname: Improve documentation.
+       * doc/posix-functions/basename.texi: Mention dirname module and
+       base_name() function.
+       * doc/posix-functions/dirname.texi: Mention dir_name() and
+       mdir_name() functions.
+       Suggested by Werner LEMBERG <address@hidden>.
+
 2014-09-24  Jim Meyering  <address@hidden>
 
        exclude: declare exclude_patopts static
diff --git a/doc/posix-functions/basename.texi 
b/doc/posix-functions/basename.texi
index 699f28e..bb068f4 100644
--- a/doc/posix-functions/basename.texi
+++ b/doc/posix-functions/basename.texi
@@ -22,3 +22,6 @@ the GNU version.
 @code{basename} assumes file names in POSIX syntax; it does not work with file
 names in Windows syntax.
 @end itemize
+
+The Gnulib module @code{dirname} provides similar API, with function
address@hidden, that also works with Windows file names.
diff --git a/doc/posix-functions/dirname.texi b/doc/posix-functions/dirname.texi
index 026f404..dd86e58 100644
--- a/doc/posix-functions/dirname.texi
+++ b/doc/posix-functions/dirname.texi
@@ -20,5 +20,6 @@ IRIX 6.5, Solaris 2.5.1, mingw, MSVC 9, BeOS.
 names in Windows syntax.
 @end itemize
 
-The Gnulib module @code{dirname} provides similar API that also works with
-Windows file names.
+The Gnulib module @code{dirname} provides similar API, with functions
address@hidden and @{code{mdir_name}, that also works with Windows
+file names.
-- 
2.1.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]