cvs: peardoc /en/pyrus/configuration user.xml /en/pyrus/configuration/user paranoia.xml

cellog		Fri Jul  3 18:54:01 2009 UTC

  Added files:                 
    /peardoc/en/pyrus/configuration/user	paranoia.xml 

  Modified files:              
    /peardoc/en/pyrus/configuration	user.xml 
  Log:
  add docs on paranoia setting
  
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/pyrus/configuration/user.xml
diff -u peardoc/en/pyrus/configuration/user.xml:1.3 peardoc/en/pyrus/configuration/user.xml:1.4
--- peardoc/en/pyrus/configuration/user.xml:1.3	Sun Jun 28 03:13:25 2009
+++ peardoc/en/pyrus/configuration/user.xml	Fri Jul  3 18:54:01 2009
@@ -43,6 +43,7 @@
  <cache_dir>/home/user/testpear/cache</cache_dir>
  <temp_dir>/home/user/testpear/temp</temp_dir>
  <verbose>1</verbose>
+ <paranoia>2</paranoia>
  <preferred_state>stable</preferred_state>
  <umask>0022</umask>
  <cache_ttl>3600</cache_ttl>
@@ -77,4 +78,5 @@
  &pyrus.configuration.user.umask;
  &pyrus.configuration.user.username;
  &pyrus.configuration.user.verbose;
+ &pyrus.configuration.user.paranoia;
 </section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/paranoia.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/configuration/user/paranoia.xml
+++ peardoc/en/pyrus/configuration/user/paranoia.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.configuration.user.paranoia">
 <info><title>verbose</title></info>

 <section xml:id="pyrus.configuration.user.paranoia.intro">
  <info><title>Introduction</title></info>
  <para>
   The <literal>paranoia</literal> setting controls how Pyrus handles automatic upgrades
   to new versions of packages.  The <link linkend="guide.users.concepts.api">API</link>
   version of the installed package is compared against the API version of remote
   packages, and chooses a release that is compatible with the current version
   based on the paranoia level.  This setting does not affect upgrades of
   local packages, only those retrieved from a remote PEAR channel server.
  </para>
  <para>
   The paranoia setting is a numeric setting with levels <literal>1</literal>
   to <literal>4</literal> supported, anything above <literal>4</literal> is
   automatically converted to <literal>4</literal>.  The levels work as follows:
  </para>
  <para>
   <orderedlist>
    <listitem> <!-- 1 -->
     <para>
      API version is ignored, only package stability and PHP version compatibility
      is used to determine which package to download for installation.
     </para>
    </listitem>
    <listitem> <!-- 2 -->
     <para>
      This is the default setting, and specifies that backwards compatibility
      must be maintained.
     </para>
     <para>
      This is performed by checking that the
      API version first digit does not change.  Thus a package with
      API version of <literal>1.2.3</literal> cannot upgrade to a new package
      with API version <literal>2.0.0</literal>.  Upgrades are allowed
      to versions such as <literal>1.2.4</literal> or <literal>1.3.0</literal>.
     </para>
    </listitem>
    <listitem> <!-- 3 -->
     <para>
      This is a strict setting, only allowing security and other API bugfixes.
     </para>
     <para>
      This is performed by checking that the API version's first and second
      digits do not change.  Thus a package with
      API version of <literal>1.2.3</literal> cannot upgrade to a new package
      with API version <literal>2.0.0</literal>.  Upgrades are allowed
      to versions such as <literal>1.2.4</literal>, but not to
      <literal>1.3.0</literal>.
     </para>
    </listitem>
    <listitem> <!-- 4 -->
     <para>
      Do not allow any API changes
     </para>
     <para>
      This is the most paranoid setting, and prevents upgrading to any package
      that changes API version whatsoever.
     </para>
    </listitem>
   </orderedlist>
  </para>
  <para>
   If using pyrus.phar, the setting can also be changed with the <literal>-p</literal>
   command-line option.  This example sets paranoia temporarily to 1:
   <screen>php pyrus.phar -p install PackageName</screen>
   This example sets paranoia temporarily to 4:
   <screen>php pyrus.phar -pppp install PackageName</screen>
  </para>
 </section>
</section>