From b98d13dfff1be571195202fb2feb93b0ae2aa763 Mon Sep 17 00:00:00 2001
From: Damien Seguy <dams@php.net>
Date: Mon, 25 Jun 2001 13:01:14 +0000
Subject: [PATCH] Some obvious cross-reference (put/get env).

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@50179 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/info.xml | 38 ++++++++++++++++++++++++--------------
 1 file changed, 24 insertions(+), 14 deletions(-)

diff --git a/functions/info.xml b/functions/info.xml
index 1331f5697b..1172ae7ab9 100644
--- a/functions/info.xml
+++ b/functions/info.xml
@@ -5,7 +5,7 @@
   <refentry id="function.assert">
    <refnamediv>
     <refname>assert</refname>
-    <refpurpose>Checks if assertion is false</refpurpose>
+    <refpurpose>Checks if assertion is FALSE</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -18,7 +18,7 @@
     <para>
      <function>assert</function> will check the given 
      <parameter>assertion</parameter> and take appropriate 
-     action if its result is <literal>false</literal>.
+     action if its result is <literal>FALSE</literal>.
     </para>
     <para>
      If the <parameter>assertion</parameter> is given as a string it
@@ -31,7 +31,7 @@
     <para>
      Assertion should be used as a debugging feature only. You may
      use them for sanity-checks that test for conditions that should
-     always be true and that indicate some programming errors if not
+     always be TRUE and that indicate some programming errors if not
      or to check for the presence of certain features like extension
      functions or certain system limits and features.
     </para>
@@ -120,7 +120,7 @@
     </table>
     <para>
      <function>assert_options</function> will return the original
-     setting of any option or <literal>false</literal> on errors.
+     setting of any option or <literal>FALSE</literal> on errors.
     </para>
    </refsect1>
   </refentry> 
@@ -139,7 +139,7 @@
      </funcprototype>
     </funcsynopsis>
     <simpara>
-     Returns true if the extension identified by
+     Returns TRUE if the extension identified by
      <parameter>name</parameter> is loaded. You can see the names of
      various extensions by using <function>phpinfo</function>.
     </simpara>
@@ -191,7 +191,7 @@
     </funcsynopsis>
     <para>
      Returns the value of the environment variable
-     <parameter>varname</parameter>, or false on an error.
+     <parameter>varname</parameter>, or FALSE on an error.
 
      <informalexample>
       <programlisting>
@@ -212,6 +212,10 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user
       </para>
      </note>
     </para>
+   <para>
+    See also
+    <function>putenv</function>.
+   </para>
    </refsect1>
   </refentry>
 
@@ -232,7 +236,7 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user
     </funcsynopsis>
     <simpara>
      Returns the current value of the PHP configuration variable
-     specified by <parameter>varname</parameter>, or false if an error
+     specified by <parameter>varname</parameter>, or FALSE if an error
      occurs.
     </simpara>
     <simpara>
@@ -349,7 +353,7 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user
     <para>
      Returns the time of the last modification of the current
      page. The value returned is a Unix timestamp, suitable for
-     feeding to <function>date</function>. Returns false on error.
+     feeding to <function>date</function>. Returns FALSE on error.
      <example>
       <title>getlastmod() example</title>
       <programlisting role="php">
@@ -382,7 +386,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod());
      </funcprototype>
     </funcsynopsis>
     <para>
-     Returns the current script's inode, or false on error.
+     Returns the current script's inode, or FALSE on error.
     </para>
     <para>
      See also <function>getmyuid</function>,
@@ -412,7 +416,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod());
      </funcprototype>
     </funcsynopsis>
     <para>
-     Returns the current PHP process ID, or false on error.
+     Returns the current PHP process ID, or FALSE on error.
     </para>
     <warning>
      <para>
@@ -444,7 +448,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod());
      </funcprototype>
     </funcsynopsis>
     <simpara>
-     Returns the user ID of the current script, or false on error.
+     Returns the user ID of the current script, or FALSE on error.
     </simpara>
     <simpara>
      See also <function>getmypid</function>,
@@ -508,7 +512,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
     </funcsynopsis>
     <para>
      Changes the value of a configuration option, returns
-     <literal>false</literal> on failure, and the previous value of the
+     <literal>FALSE</literal> on failure, and the previous value of the
      configuration option on success.
     </para>
     <note>
@@ -539,7 +543,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
     </funcsynopsis>
     <para>
      Returns the value of the configuration option on success,
-     <literal>false</literal> on failure.
+     <literal>FALSE</literal> on failure.
     </para>
     <para>
      See also <function>ini_alter</function>,
@@ -589,7 +593,9 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
     </funcsynopsis>
     <para>
      Sets the value of the given configuration option. Returns the old
-     value on success, <literal>false</literal> on failure.
+     value on success, <literal>FALSE</literal> on failure. The configuration
+     option will keep this new value during the script's execution,
+     and will be restored at the script's ending.
     </para>
     <para>
      Not all the available options can be changed using
@@ -1270,6 +1276,10 @@ putenv ("UNIQID=$uniqid");
       </programlisting>
      </example>
     </para>
+   <para>
+    See also
+    <function>getenv</function>.
+   </para>
    </refsect1>
   </refentry>