From 45f5fbc3521fdab254b53380e3622ef468c578be Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Fri, 13 Jun 2003 01:40:03 +0000
Subject: [PATCH] Returns bool not int, closes bug #24162

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@131282 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/filesystem/functions/chgrp.xml   | 4 ++--
 reference/filesystem/functions/chmod.xml   | 4 ++--
 reference/filesystem/functions/chown.xml   | 4 ++--
 reference/filesystem/functions/link.xml    | 4 ++--
 reference/filesystem/functions/mkdir.xml   | 4 ++--
 reference/filesystem/functions/rewind.xml  | 8 ++++----
 reference/filesystem/functions/rmdir.xml   | 4 ++--
 reference/filesystem/functions/symlink.xml | 7 +++++--
 reference/filesystem/functions/touch.xml   | 4 ++--
 reference/filesystem/functions/unlink.xml  | 4 ++--
 10 files changed, 25 insertions(+), 22 deletions(-)

diff --git a/reference/filesystem/functions/chgrp.xml b/reference/filesystem/functions/chgrp.xml
index 2b93430460..fc77208dc4 100644
--- a/reference/filesystem/functions/chgrp.xml
+++ b/reference/filesystem/functions/chgrp.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.chgrp">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>chgrp</methodname>
+      <type>bool</type><methodname>chgrp</methodname>
       <methodparam><type>string</type><parameter>filename</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>group</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/filesystem/functions/chmod.xml b/reference/filesystem/functions/chmod.xml
index 34e35c6282..a37f791168 100644
--- a/reference/filesystem/functions/chmod.xml
+++ b/reference/filesystem/functions/chmod.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.chmod">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>chmod</methodname>
+      <type>bool</type><methodname>chmod</methodname>
       <methodparam><type>string</type><parameter>filename</parameter></methodparam>
       <methodparam><type>int</type><parameter>mode</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/filesystem/functions/chown.xml b/reference/filesystem/functions/chown.xml
index b1f6669f80..31b3b77613 100644
--- a/reference/filesystem/functions/chown.xml
+++ b/reference/filesystem/functions/chown.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.chown">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>chown</methodname>
+      <type>bool</type><methodname>chown</methodname>
       <methodparam><type>string</type><parameter>filename</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>user</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/filesystem/functions/link.xml b/reference/filesystem/functions/link.xml
index e7d13da59d..ea7fbaa205 100644
--- a/reference/filesystem/functions/link.xml
+++ b/reference/filesystem/functions/link.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.link">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>link</methodname>
+      <type>bool</type><methodname>link</methodname>
       <methodparam><type>string</type><parameter>target</parameter></methodparam>
       <methodparam><type>string</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/filesystem/functions/mkdir.xml b/reference/filesystem/functions/mkdir.xml
index abb8dee2b0..ea39523023 100644
--- a/reference/filesystem/functions/mkdir.xml
+++ b/reference/filesystem/functions/mkdir.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.39 -->
   <refentry id="function.mkdir">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>mkdir</methodname>
+      <type>bool</type><methodname>mkdir</methodname>
       <methodparam><type>string</type><parameter>pathname</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/filesystem/functions/rewind.xml b/reference/filesystem/functions/rewind.xml
index 23dff16459..61f18ce1df 100644
--- a/reference/filesystem/functions/rewind.xml
+++ b/reference/filesystem/functions/rewind.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.rewind">
    <refnamediv>
@@ -9,15 +9,15 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>rewind</methodname>
+      <type>bool</type><methodname>rewind</methodname>
       <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
      </methodsynopsis>
     <para>    
      Sets the file position indicator for <parameter>handle</parameter>
      to the beginning of the file stream.
     </para> 
-    <para> 
-     If an error occurs, returns 0, otherwise it returns 1.
+    <para>
+     &return.success;
     </para>
     <para>
      The file pointer must be valid, and must point to a file
diff --git a/reference/filesystem/functions/rmdir.xml b/reference/filesystem/functions/rmdir.xml
index 32ca6db6d8..373711ca03 100644
--- a/reference/filesystem/functions/rmdir.xml
+++ b/reference/filesystem/functions/rmdir.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.rmdir">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
     <methodsynopsis>
-     <type>int</type><methodname>rmdir</methodname>
+     <type>bool</type><methodname>rmdir</methodname>
      <methodparam><type>string</type><parameter>dirname</parameter></methodparam>
     </methodsynopsis>
     <para> 
diff --git a/reference/filesystem/functions/symlink.xml b/reference/filesystem/functions/symlink.xml
index 7c47eb4805..f2dabf8837 100644
--- a/reference/filesystem/functions/symlink.xml
+++ b/reference/filesystem/functions/symlink.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.symlink">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>symlink</methodname>
+      <type>bool</type><methodname>symlink</methodname>
       <methodparam><type>string</type><parameter>target</parameter></methodparam>
       <methodparam><type>string</type><parameter>link</parameter></methodparam>
      </methodsynopsis>
@@ -18,6 +18,9 @@
      from the existing <parameter>target</parameter> with
      the specified name <parameter>link</parameter>.
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      See also <function>link</function> to create hard links,
      and <function>readlink</function> along with
diff --git a/reference/filesystem/functions/touch.xml b/reference/filesystem/functions/touch.xml
index 601442fe06..25c9816028 100644
--- a/reference/filesystem/functions/touch.xml
+++ b/reference/filesystem/functions/touch.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.touch">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>touch</methodname>
+      <type>bool</type><methodname>touch</methodname>
       <methodparam><type>string</type><parameter>filename</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>time</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>atime</parameter></methodparam>
diff --git a/reference/filesystem/functions/unlink.xml b/reference/filesystem/functions/unlink.xml
index 9e18ebec12..ab9e3ffe68 100644
--- a/reference/filesystem/functions/unlink.xml
+++ b/reference/filesystem/functions/unlink.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.unlink">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>unlink</methodname>
+      <type>bool</type><methodname>unlink</methodname>
       <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      </methodsynopsis>
     <para>