summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Brobecker <brobecker@gnat.com>2007-04-06 06:01:54 +0000
committerJoel Brobecker <brobecker@gnat.com>2007-04-06 06:01:54 +0000
commit7a0eba832681377b30ec4da14a3e919629cf5df4 (patch)
tree15bc3d12ac95efd4b84b16ed49601e3d7eaf017c
parentf9baef8a8557b39d521aa1666430ec28d967e399 (diff)
downloadgdb-7a0eba832681377b30ec4da14a3e919629cf5df4.tar.gz
* filename_cmp.c (filename_cmp): Improve documentation.
-rw-r--r--libiberty/ChangeLog4
-rw-r--r--libiberty/filename_cmp.c11
2 files changed, 10 insertions, 5 deletions
diff --git a/libiberty/ChangeLog b/libiberty/ChangeLog
index f790651748a..62d3929d22b 100644
--- a/libiberty/ChangeLog
+++ b/libiberty/ChangeLog
@@ -1,3 +1,7 @@
+2007-04-06 Joel Brobecker <brobecker@adacore.com>
+
+ * filename_cmp.c (filename_cmp): Improve documentation.
+
2007-04-02 Andreas Schwab <schwab@suse.de>
* filename_cmp.c: Include "config.h".
diff --git a/libiberty/filename_cmp.c b/libiberty/filename_cmp.c
index d2052b48717..59bb726b90e 100644
--- a/libiberty/filename_cmp.c
+++ b/libiberty/filename_cmp.c
@@ -31,12 +31,13 @@
@deftypefn Extension int filename_cmp (const char *@var{s1}, const char *@var{s2})
-Return zero if the two paths @var{s1} and @var{s2} are equivalent.
-If not equivalent, the returned value is similar to what strcmp would
-return. In other words, it returns a negative value if @var{s1} is less
-than @var{s2}, or a positive value if @var{s2} is greater than @var{s2}.
+Return zero if the two file names @var{s1} and @var{s2} are equivalent.
+If not equivalent, the returned value is similar to what @code{strcmp}
+would return. In other words, it returns a negative value if @var{s1}
+is less than @var{s2}, or a positive value if @var{s2} is greater than
+@var{s2}.
-This function does not normalize path names. As a result, this function
+This function does not normalize file names. As a result, this function
will treat filenames that are spelled differently as different even in
the case when the two filenames point to the same underlying file.
However, it does handle the fact that on DOS-like file systems, forward