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

cellog		Sun Jun 28 14:37:26 2009 UTC

  Modified files:              
    /peardoc/en/pyrus/differences	frompear.xml 
  Log:
  add note on package.xml differences in Pyrus
  
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/differences/frompear.xml?r1=1.9&r2=1.10&diff_format=u
Index: peardoc/en/pyrus/differences/frompear.xml
diff -u peardoc/en/pyrus/differences/frompear.xml:1.9 peardoc/en/pyrus/differences/frompear.xml:1.10
--- peardoc/en/pyrus/differences/frompear.xml:1.9	Sun Jun 28 03:13:25 2009
+++ peardoc/en/pyrus/differences/frompear.xml	Sun Jun 28 14:37:26 2009
@@ -273,6 +273,65 @@
    the package would look on disk when installed with the XML registry.
   </para>
  </section>
+ <section xml:id="pyrus.differences.frompear.packagexml">
+  <info><title>package.xml changes</title></info>
+  <para>
+   Pyrus no longer supports
+   <link linkend="developers.packagedef.intro">package.xml version 1.0</link>,
+   although it will include a package.xml version 1.0 in an archive designed
+   to support both earlier PEAR versions and the more recent versions.  It does
+   not validate the package.xml, however, and so it is important to validate
+   any older package.xml format using PEAR and not Pyrus.
+  </para>
+  <para>
+   In addition, Pyrus has introduced support for PEAR2 packages that can
+   be extracted to disk and then later upgraded using Pyrus.  To implement
+   this feature, Pyrus transforms paths in a different way from PEAR.
+  </para>
+  <para>
+   For example, this entry from a package.xml:
+  </para>
+  <para>
+   <programlisting role="xml">
+    <![CDATA[
+   <dir name="php" baseinstalldir="PEAR2">
+    <dir name="Pyrus">
+     <dir name="Developer">
+      <dir name="CoverageAnalyzer">
+       <dir name="SourceFile">
+        <file role="php" name="PerTest.php"/>
+       </dir>
+      </dir>
+     </dir>
+    </dir>
+   </dir>
+    ]]>
+   </programlisting>
+  </para>
+  <para>
+   would cause PEAR to install <literal>PerTest.php</literal> into the
+   relative path <literal>PEAR2/php/Pyrus/Developer/CoverageAnalyzer/SourceFile/PerTest.php</literal>.
+   Pyrus, however, recognizes that <literal>php</literal> is actually the default value of
+   the <link linkend="pyrus.configuration.system.phpdir">php_dir</link> system
+   configuration variable, and strips it from the path, resulting in
+   <literal>PerTest.php</literal> being installed into the path:
+   <literal>PEAR2/Pyrus/Developer/CoverageAnalyzer/SourceFile/PerTest.php</literal>.
+  </para>
+  <para>
+   To enable this handling, one need only set the &lt;pearinstaller&gt;
+   dependency to version <literal>2.0.0a1</literal> or newer.  Pyrus will
+   automatically recognize any package.xml with a &lt;pearinstaller&gt;
+   dependency on any version of the PEAR Installer as an older package.xml, and
+   will not perform the magic removal of configuration values from
+   directories.
+  </para>
+  <para>
+   No other changes have been made to package.xml handling, except that the
+   default version of package.xml used when generating a package.xml is
+   version 2.1, which has been supported by the PEAR Installer since
+   version <literal>1.5.0</literal>.
+  </para>
+ </section>
  <section xml:id="pyrus.differences.frompear.plugins">
   <info><title>Extending Pyrus: plugins</title></info>
   <para>