cvs: peardoc /en/pyrus/differences frompear.xml

cellog		Thu Jun 18 21:43:16 2009 UTC

  Modified files:              
    /peardoc/en/pyrus/differences	frompear.xml 
  Log:
  new docs on Pyrus registry formats
  
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/differences/frompear.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/pyrus/differences/frompear.xml
diff -u peardoc/en/pyrus/differences/frompear.xml:1.3 peardoc/en/pyrus/differences/frompear.xml:1.4
--- peardoc/en/pyrus/differences/frompear.xml:1.3	Thu Jun 18 21:16:26 2009
+++ peardoc/en/pyrus/differences/frompear.xml	Thu Jun 18 21:43:16 2009
@@ -209,7 +209,50 @@
  <section xml:id="pyrus.differences.frompear.registry">
   <info><title>Registries</title></info>
   <para>
-   work in progress.
+   Pyrus fully supports PEAR's registry format, but introduces 2 new registry formats,
+   an sqlite3 database-based registry, and an XML file-based registry.  These
+   registries are fully redundant, and can be used to repair or reconstruct a corrupt
+   registry.
+  </para>
+  <para>
+   In addition, unlike PEAR, which stores the registry in the same directory as
+   the PHP source files, Pyrus stores the registry in its parent directory.
+   Thus, PHP files stored in <literal>/usr/local/lib/php</literal> have their
+   registry in <literal>/usr/local/lib</literal>.
+  </para>
+  <note>
+   <simpara>
+    For backwards compatibility, an older PEAR registry is always
+    stored in the location the PEAR Installer expects it to be stored.
+   </simpara>
+  </note>
+  <para>
+   Pyrus is intelligent enough to detect which registries are present, and
+   to use them.  If only an older PEAR registry exists, Pyrus will not
+   automatically upgrade to the newer format.  However, the
+   <literal>upgrade-registries</literal> command is available to convert from
+   an older registry to the newer format.
+  </para>
+  <para>
+   Some of the benefits of the newer registry format include much speedier
+   processing of a large registry at installation time due to Sqlite3's
+   speedy processing.  Additionally, truly safe uninstall-time resolution of
+   dependencies is possible, something that PEAR can only do for relatively
+   simple package dependency trees.
+  </para>
+  <para>
+   In addition, the XML registry consists of storing the package.xml and
+   channel.xml files for package releases in the same location that they
+   are packaged.  This is what makes it possible to extract a package
+   created with Pyrus and then later use Pyrus to upgrade it.
+  </para>
+  <para>
+   For instance, the hypothetical <literal>PEAR2_Foo</literal> package from
+   channel <literal>pear2.php.net</literal> version <literal>1.2.3</literal>
+   will store its package.xml in path
+   <literal>.xmlregistry/packages/pear2.php.net/PEAR2_Foo/1.2.3-package.xml</literal>
+   inside the archive, so that when it is extracted, it lines up exactly with how
+   the package would look on disk when installed with the XML registry.
   </para>
  </section>
  <section xml:id="pyrus.differences.frompear.plugins">