(rb_f_test): fix document. [ruby-dev:28087]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9731 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 11 insertions, 1 deletions

diff --git a/file.c b/file.c
index 71051857e5..cc09a42cd9 100644
--- a/file.c
+++ b/file.c
@@ -1399,6 +1399,16 @@ test_sticky(VALUE obj, VALUE fname)
  *   File.identical?(file_1, file_2)   =>  true or false
  *
  * Returns <code>true</code> if the named files are identical.
+ *
+ *     open("a", "w") {}
+ *     p File.identical?("a", "a")      #=> true
+ *     p File.identical?("a", "./a")    #=> true
+ *     File.link("a", "b")
+ *     p File.identical?("a", "b")      #=> true
+ *     File.symlink("a", "c")
+ *     p File.identical?("a", "c")      #=> true
+ *     open("d", "w") {}
+ *     p File.identical?("a", "d")      #=> false
  */
 
 static VALUE
@@ -3195,7 +3205,7 @@ test_check(int n, int argc, VALUE *argv)
  *
  * Tests that take two files:
  *
- *     ?-  | boolean | True if file1 is a hard link to file2
+ *     ?-  | boolean | True if file1 and file2 are identical
  *     ?=  | boolean | True if the modification times of file1
  *         |         | and file2 are equal
  *     ?<  | boolean | True if the modification time of file1