[RFA/libiberty] Fix documentation issues in filename_cmp.c

Joel Brobecker
2007-04-05T17:27:28Z

[-- Attachment #1: Type: text/plain, Size: 302 bytes --]

Hello,

The attached patch incorporates all the documentation changes that Eli
has recommended. No code change.

2007-04-05 Joel Brobecker <brobecker@adacore.com>

* filename_cmp.c (filename_cmp): Improve documentation.

Tested on x86-linux by rebuilding GDB. OK to apply?

Thanks,
--
Joel

[-- Attachment #2: filename_cmp.2.diff --]
[-- Type: text/plain, Size: 1377 bytes --]

Index: libiberty/filename_cmp.c
===================================================================
RCS file: /cvs/src/src/libiberty/filename_cmp.c,v
retrieving revision 1.2
diff -u -p -r1.2 filename_cmp.c
--- libiberty/filename_cmp.c 2 Apr 2007 11:20:52 -0000 1.2
+++ libiberty/filename_cmp.c 5 Apr 2007 17:21:47 -0000
@@ -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