summaryrefslogtreecommitdiff
path: root/libiberty/filename_cmp.c
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
commit2b8688ddba16f140861967e2a4fbb2c1514d37e6 (patch)
tree93ca708a7c898d03abba946b2f4653f610271b32 /libiberty/filename_cmp.c
parent9f548dc6fbbef525107f0ad1524a32767c57cdf8 (diff)
downloadbinutils-redhat-2b8688ddba16f140861967e2a4fbb2c1514d37e6.tar.gz
* filename_cmp.c (filename_cmp): Improve documentation.
Diffstat (limited to 'libiberty/filename_cmp.c')
-rw-r--r--libiberty/filename_cmp.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/libiberty/filename_cmp.c b/libiberty/filename_cmp.c
index d2052b4871..59bb726b90 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