From 7d4843d6a14294e3172cf30845dfd57df695a4fb Mon Sep 17 00:00:00 2001
From: Jon Parise <jon@php.net>
Date: Tue, 15 May 2001 23:51:56 +0000
Subject: [PATCH] Documentation for the new disk_total_space() function.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@47543 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/filesystem.xml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/functions/filesystem.xml b/functions/filesystem.xml
index 0662499849..d27827affe 100644
--- a/functions/filesystem.xml
+++ b/functions/filesystem.xml
@@ -330,6 +330,36 @@ $df = diskfreespace("/"); // $df contains the number of bytes
    </refsect1>
   </refentry>
 
+  <refentry id="function.disk-total-space">
+   <refnamediv>
+    <refname>disk_total_space</refname>
+    <refpurpose>Returns the total size of a directory</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>float <function>disk_total_space</function></funcdef>
+      <paramdef>string <parameter>directory</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     Given a string containing a directory, this function will return
+     the total number of bytes on the corresponding filesystem or disk
+     partition.
+    </para>
+    <para>
+     <example>
+      <title><function>disk_total_space</function> example</title>
+      <programlisting role="php">
+$df = disk_total_space("/"); // $df contains the total number of
+                             // bytes available on "/"
+      </programlisting>
+     </example>
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.fclose">
    <refnamediv>
     <refname>fclose</refname>