merge revision(s) 40440:

update doc.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_0_0@40448 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nagachika 2013-04-24 15:42:02 +00:00
parent 02d1ebe360
commit 917f13a953
2 changed files with 39 additions and 1 deletions

38
file.c
View file

@ -1135,6 +1135,8 @@ eaccess(const char *path, int mode)
* or a symlink that points at a directory, and <code>false</code> * or a symlink that points at a directory, and <code>false</code>
* otherwise. * otherwise.
* *
* _file_name_ can be an IO object.
*
* File.directory?(".") * File.directory?(".")
*/ */
@ -1157,6 +1159,8 @@ rb_file_directory_p(VALUE obj, VALUE fname)
* File.pipe?(file_name) -> true or false * File.pipe?(file_name) -> true or false
* *
* Returns <code>true</code> if the named file is a pipe. * Returns <code>true</code> if the named file is a pipe.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1218,6 +1222,8 @@ rb_file_symlink_p(VALUE obj, VALUE fname)
* File.socket?(file_name) -> true or false * File.socket?(file_name) -> true or false
* *
* Returns <code>true</code> if the named file is a socket. * Returns <code>true</code> if the named file is a socket.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1252,6 +1258,8 @@ rb_file_socket_p(VALUE obj, VALUE fname)
* File.blockdev?(file_name) -> true or false * File.blockdev?(file_name) -> true or false
* *
* Returns <code>true</code> if the named file is a block device. * Returns <code>true</code> if the named file is a block device.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1280,6 +1288,8 @@ rb_file_blockdev_p(VALUE obj, VALUE fname)
* File.chardev?(file_name) -> true or false * File.chardev?(file_name) -> true or false
* *
* Returns <code>true</code> if the named file is a character device. * Returns <code>true</code> if the named file is a character device.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
rb_file_chardev_p(VALUE obj, VALUE fname) rb_file_chardev_p(VALUE obj, VALUE fname)
@ -1302,6 +1312,10 @@ rb_file_chardev_p(VALUE obj, VALUE fname)
* File.exists?(file_name) -> true or false * File.exists?(file_name) -> true or false
* *
* Return <code>true</code> if the named file exists. * Return <code>true</code> if the named file exists.
*
* _file_name_ can be an IO object.
*
* "file exists" means that stat() or fstat() system call is successful.
*/ */
static VALUE static VALUE
@ -1366,6 +1380,8 @@ rb_file_readable_real_p(VALUE obj, VALUE fname)
* <code>nil</code> otherwise. The meaning of the bits is platform * <code>nil</code> otherwise. The meaning of the bits is platform
* dependent; on Unix systems, see <code>stat(2)</code>. * dependent; on Unix systems, see <code>stat(2)</code>.
* *
* _file_name_ can be an IO object.
*
* File.world_readable?("/etc/passwd") #=> 420 * File.world_readable?("/etc/passwd") #=> 420
* m = File.world_readable?("/etc/passwd") * m = File.world_readable?("/etc/passwd")
* sprintf("%o", m) #=> "644" * sprintf("%o", m) #=> "644"
@ -1430,6 +1446,8 @@ rb_file_writable_real_p(VALUE obj, VALUE fname)
* <code>nil</code> otherwise. The meaning of the bits is platform * <code>nil</code> otherwise. The meaning of the bits is platform
* dependent; on Unix systems, see <code>stat(2)</code>. * dependent; on Unix systems, see <code>stat(2)</code>.
* *
* _file_name_ can be an IO object.
*
* File.world_writable?("/tmp") #=> 511 * File.world_writable?("/tmp") #=> 511
* m = File.world_writable?("/tmp") * m = File.world_writable?("/tmp")
* sprintf("%o", m) #=> "777" * sprintf("%o", m) #=> "777"
@ -1495,6 +1513,8 @@ rb_file_executable_real_p(VALUE obj, VALUE fname)
* *
* Returns <code>true</code> if the named file exists and is a * Returns <code>true</code> if the named file exists and is a
* regular file. * regular file.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1513,6 +1533,8 @@ rb_file_file_p(VALUE obj, VALUE fname)
* *
* Returns <code>true</code> if the named file exists and has * Returns <code>true</code> if the named file exists and has
* a zero size. * a zero size.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1531,6 +1553,8 @@ rb_file_zero_p(VALUE obj, VALUE fname)
* *
* Returns +nil+ if +file_name+ doesn't exist or has zero size, the size of the * Returns +nil+ if +file_name+ doesn't exist or has zero size, the size of the
* file otherwise. * file otherwise.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1550,6 +1574,8 @@ rb_file_size_p(VALUE obj, VALUE fname)
* Returns <code>true</code> if the named file exists and the * Returns <code>true</code> if the named file exists and the
* effective used id of the calling process is the owner of * effective used id of the calling process is the owner of
* the file. * the file.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1579,6 +1605,8 @@ rb_file_rowned_p(VALUE obj, VALUE fname)
* Returns <code>true</code> if the named file exists and the * Returns <code>true</code> if the named file exists and the
* effective group id of the calling process is the owner of * effective group id of the calling process is the owner of
* the file. Returns <code>false</code> on Windows. * the file. Returns <code>false</code> on Windows.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1665,6 +1693,8 @@ rb_file_sticky_p(VALUE obj, VALUE fname)
* *
* Returns <code>true</code> if the named files are identical. * Returns <code>true</code> if the named files are identical.
* *
* _file_1_ and _file_2_ can be an IO object.
*
* open("a", "w") {} * open("a", "w") {}
* p File.identical?("a", "a") #=> true * p File.identical?("a", "a") #=> true
* p File.identical?("a", "./a") #=> true * p File.identical?("a", "./a") #=> true
@ -1729,6 +1759,8 @@ rb_file_identical_p(VALUE obj, VALUE fname1, VALUE fname2)
* File.size(file_name) -> integer * File.size(file_name) -> integer
* *
* Returns the size of <code>file_name</code>. * Returns the size of <code>file_name</code>.
*
* _file_name_ can be an IO object.
*/ */
static VALUE static VALUE
@ -1820,6 +1852,8 @@ rb_file_s_ftype(VALUE klass, VALUE fname)
* *
* Returns the last access time for the named file as a Time object). * Returns the last access time for the named file as a Time object).
* *
* _file_name_ can be an IO object.
*
* File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003 * File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003
* *
*/ */
@ -1866,6 +1900,8 @@ rb_file_atime(VALUE obj)
* *
* Returns the modification time for the named file as a Time object. * Returns the modification time for the named file as a Time object.
* *
* _file_name_ can be an IO object.
*
* File.mtime("testfile") #=> Tue Apr 08 12:58:04 CDT 2003 * File.mtime("testfile") #=> Tue Apr 08 12:58:04 CDT 2003
* *
*/ */
@ -1913,6 +1949,8 @@ rb_file_mtime(VALUE obj)
* directory information about the file was changed, not the file * directory information about the file was changed, not the file
* itself). * itself).
* *
* _file_name_ can be an IO object.
*
* Note that on Windows (NTFS), returns creation time (birth time). * Note that on Windows (NTFS), returns creation time (birth time).
* *
* File.ctime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003 * File.ctime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003

View file

@ -1,6 +1,6 @@
#define RUBY_VERSION "2.0.0" #define RUBY_VERSION "2.0.0"
#define RUBY_RELEASE_DATE "2013-04-25" #define RUBY_RELEASE_DATE "2013-04-25"
#define RUBY_PATCHLEVEL 167 #define RUBY_PATCHLEVEL 168
#define RUBY_RELEASE_YEAR 2013 #define RUBY_RELEASE_YEAR 2013
#define RUBY_RELEASE_MONTH 4 #define RUBY_RELEASE_MONTH 4