Commit 96a94ff4 by Joel Brobecker Committed by Joel Brobecker

* filename_cmp.c (filename_cmp): Improve documentation.

From-SVN: r123537
parent 2878ea73
2007-04-06 Joel Brobecker <brobecker@adacore.com>
* filename_cmp.c (filename_cmp): Improve documentation.
2007-04-02 Andreas Schwab <schwab@suse.de> 2007-04-02 Andreas Schwab <schwab@suse.de>
* filename_cmp.c: Include "config.h". * filename_cmp.c: Include "config.h".
......
...@@ -31,12 +31,13 @@ ...@@ -31,12 +31,13 @@
@deftypefn Extension int filename_cmp (const char *@var{s1}, const char *@var{s2}) @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. Return zero if the two file names @var{s1} and @var{s2} are equivalent.
If not equivalent, the returned value is similar to what strcmp would If not equivalent, the returned value is similar to what @code{strcmp}
return. In other words, it returns a negative value if @var{s1} is less would return. In other words, it returns a negative value if @var{s1}
than @var{s2}, or a positive value if @var{s2} is greater than @var{s2}. 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 will treat filenames that are spelled differently as different even in
the case when the two filenames point to the same underlying file. 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 However, it does handle the fact that on DOS-like file systems, forward
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment