cvs: peardoc / manual.xml /en language-defs.ent /en/guide/developers contributing.xml packagedef.xml /en/guide/users commandline.xml installation.xml installationpyrus.xml /en/guide/users/installation cli.xml /en/guide/users/installationpyrus introduction.xml /en/pyrus about.xml developers.xml plugins.xml /en/pyrus/developers pear.xml pear2.xml pecl.xml /en/pyrus/differences customroles.xml customtasks.xml frompear.xml postinstallscripts.xml /en/pyrus/plugins command.xml role.xml task.xml

[email protected] ("Greg Beaver")
Newsgroups php.pear.doc
Message-ID <cvscellog1245300640@cvsserver>
cellog		Thu Jun 18 04:50:40 2009 UTC

  Added files:                 
    /peardoc/en/guide/users	installationpyrus.xml 
    /peardoc/en/guide/users/installationpyrus	introduction.xml 
    /peardoc/en/pyrus	about.xml developers.xml plugins.xml 
    /peardoc/en/pyrus/developers	pear.xml pear2.xml pecl.xml 
    /peardoc/en/pyrus/differences	customroles.xml customtasks.xml 
                                 	frompear.xml postinstallscripts.xml 
    /peardoc/en/pyrus/plugins	command.xml role.xml task.xml 

  Modified files:              
    /peardoc	manual.xml 
    /peardoc/en	language-defs.ent 
    /peardoc/en/guide/developers	contributing.xml packagedef.xml 
    /peardoc/en/guide/users	commandline.xml installation.xml 
    /peardoc/en/guide/users/installation	cli.xml 
  Log:
  re-organize top-level docs, add beginnings of skeleton for Pyrus docs
cellog-20090618045040.txt (text/plain, 19 KB)
http://cvs.php.net/viewvc.cgi/peardoc/manual.xml?r1=1.6&r2=1.7&diff_format=u
Index: peardoc/manual.xml
diff -u peardoc/manual.xml:1.6 peardoc/manual.xml:1.7
--- peardoc/manual.xml:1.6	Sun May  3 12:50:12 2009
+++ peardoc/manual.xml	Thu Jun 18 04:50:40 2009
@@ -62,20 +62,26 @@
  <book xml:id="users">
    <title>&UsersGuide;</title>
 
+   &guide.users.installationpyrus;
    &guide.users.installation;
    &guide.users.commandline;
  </book>
 
+ <book xml:id="pyrus">
+   <title>&Pyrus;</title>
+
+  &pyrus.about;
+  &pyrus.plugins;
+  &pyrus.developers;
+ </book>
+
  <book xml:id="developers">
-  <title>Developer guide</title>
+  <title>&DevelopersGuide;</title>
 
   <part xml:id="about-pear">
    <title>&AboutPEAR;</title>
    &chapters.intro;
    &chapters.support;
-   &chapters.standards;
-   &chapters.pear2cs;
-   &chapters.pear2policies;
    &chapters.contributing;
    &chapters.faq;
    &chapters.constitution;
@@ -97,12 +103,19 @@
    &guide.developers.intro;
    &guide.developers.meaning;
    &guide.developers.contributing;
-   &guide.developers.packagedef;
    &guide.developers.package2;
    &guide.developers.release;
    &guide.developers.supporting;
-   &guide.developers.recommendations;
    &guide.developers.documentation;
+   &guide.developers.packagedef;
+  </part>
+
+  <part xml:id="coding-standards">
+   <title>&CodingStandards;</title>
+   &chapters.standards;
+   &chapters.pear2cs;
+   &chapters.pear2policies;
+   &guide.developers.recommendations;
   </part>
 
   <part xml:id="developers-core">
http://cvs.php.net/viewvc.cgi/peardoc/en/language-defs.ent?r1=1.10&r2=1.11&diff_format=u
Index: peardoc/en/language-defs.ent
diff -u peardoc/en/language-defs.ent:1.10 peardoc/en/language-defs.ent:1.11
--- peardoc/en/language-defs.ent:1.10	Thu Oct  9 15:16:08 2008
+++ peardoc/en/language-defs.ent	Thu Jun 18 04:50:40 2009
@@ -1,16 +1,18 @@
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 
 <!ENTITY PEARManual        "PEAR Manual">
 <!ENTITY Translatedby      "Translated by">
 <!ENTITY Date              "Date:">
-<!ENTITY AboutPEAR         "About PEAR">
-<!ENTITY DevelopersGuide   "Developer Guide">
+<!ENTITY AboutPEAR         "About PEAR and PEAR2">
+<!ENTITY CodingStandards   "Coding Standards">
+<!ENTITY Pyrus             "Using Pyrus (PHP 5.3+)">
+<!ENTITY DevelopersGuide   "PEAR Developer Guide">
 <!ENTITY UsersGuide        "User Guide">
-<!ENTITY NewMaintainersGuide   "New Maintainers' Guide">
-<!ENTITY ChangesInPear14   "New features in PEAR 1.4">
-<!ENTITY LanguageReference "Language Reference">
+<!ENTITY NewMaintainersGuide   "Becoming a PEAR developer: how to get involved">
+<!ENTITY ChangesInPear14   "Channels, package.xml and customizing packages">
 <!ENTITY Features          "Features">
 <!ENTITY PEAR              "PEAR: the PHP Extension and Application Repository">
-<!ENTITY Packages          "Packages">
-<!ENTITY Core              "Core components">
+<!ENTITY PEAR2Packages     "PEAR2 Packages">
+<!ENTITY Packages          "PEAR Packages">
+<!ENTITY Core              "PEAR Installer: Core components (Installer API, REST, error handling)">
 <!ENTITY Contributing      "Contributing to PEAR">
http://cvs.php.net/viewvc.cgi/peardoc/en/guide/developers/contributing.xml?r1=1.35&r2=1.36&diff_format=u
Index: peardoc/en/guide/developers/contributing.xml
diff -u peardoc/en/guide/developers/contributing.xml:1.35 peardoc/en/guide/developers/contributing.xml:1.36
--- peardoc/en/guide/developers/contributing.xml:1.35	Thu Oct  9 15:16:18 2008
+++ peardoc/en/guide/developers/contributing.xml	Thu Jun 18 04:50:40 2009
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="developers.contributing"><info><title>Contributing your own code</title><titleabbrev>Contributing</titleabbrev></info>
-  
-  
+<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="developers.contributing">
+    <info><title>Writing new packages, or enhancing existing packages</title>
+    <titleabbrev>Contributing code to PEAR</titleabbrev></info>
 
   <para>
    PEAR is driven by an <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.opensource;">open
@@ -12,7 +12,8 @@
    those requirements that you must adhere to in order to contribute to PEAR.
   </para>
 
-  <section xml:id="developers.contributing.requirements"><info><title>Requirements for contributing code</title><titleabbrev>Requirements</titleabbrev></info>
+  <section xml:id="developers.contributing.requirements">
+    <info><title>Requirements for contributing code</title><titleabbrev>Requirements</titleabbrev></info>
    
    
 
@@ -60,7 +61,7 @@
 
      <listitem>
        <simpara>
-         Code must be available in public code repository.
+         Code must be available in a public code repository.
        </simpara>
        <para>
          The latest revision of the package's source code has to be
http://cvs.php.net/viewvc.cgi/peardoc/en/guide/developers/packagedef.xml?r1=1.40&r2=1.41&diff_format=u
Index: peardoc/en/guide/developers/packagedef.xml
diff -u peardoc/en/guide/developers/packagedef.xml:1.40 peardoc/en/guide/developers/packagedef.xml:1.41
--- peardoc/en/guide/developers/packagedef.xml:1.40	Thu Oct  9 15:16:18 2008
+++ peardoc/en/guide/developers/packagedef.xml	Thu Jun 18 04:50:40 2009
@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="developers.packagedef"><info><title>The package definition file <filename>package.xml</filename></title><titleabbrev><filename>package.xml</filename></titleabbrev></info>
+<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="developers.packagedef">
+    <info><title>The package definition file <filename>package.xml</filename> (deprecated)</title>
+    <titleabbrev><filename>package.xml</filename></titleabbrev></info>
   
   
 
http://cvs.php.net/viewvc.cgi/peardoc/en/guide/users/commandline.xml?r1=1.7&r2=1.8&diff_format=u
Index: peardoc/en/guide/users/commandline.xml
diff -u peardoc/en/guide/users/commandline.xml:1.7 peardoc/en/guide/users/commandline.xml:1.8
--- peardoc/en/guide/users/commandline.xml:1.7	Thu Oct  9 15:16:18 2008
+++ peardoc/en/guide/users/commandline.xml	Thu Jun 18 04:50:40 2009
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="guide.users.commandline.cli"><info><title>Command line installer</title></info>
+<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="guide.users.commandline.cli">
+    <info><title>Command line installer (PEAR)</title></info>
   
 
   <warning><info><title>Prerequisites</title></info>
http://cvs.php.net/viewvc.cgi/peardoc/en/guide/users/installation.xml?r1=1.8&r2=1.9&diff_format=u
Index: peardoc/en/guide/users/installation.xml
diff -u peardoc/en/guide/users/installation.xml:1.8 peardoc/en/guide/users/installation.xml:1.9
--- peardoc/en/guide/users/installation.xml:1.8	Tue Feb 24 21:39:27 2009
+++ peardoc/en/guide/users/installation.xml	Thu Jun 18 04:50:40 2009
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="installation">
   <info>
-   <title>Installation</title>
+   <title>Installation (PEAR)</title>
    <author><personname><firstname>Martin</firstname><surname>Jansen</surname></personname></author>
    <date>2006-11-25</date>
   </info>
http://cvs.php.net/viewvc.cgi/peardoc/en/guide/users/installation/cli.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/guide/users/installation/cli.xml
diff -u peardoc/en/guide/users/installation/cli.xml:1.3 peardoc/en/guide/users/installation/cli.xml:1.4
--- peardoc/en/guide/users/installation/cli.xml:1.3	Thu Oct  9 15:16:18 2008
+++ peardoc/en/guide/users/installation/cli.xml	Thu Jun 18 04:50:40 2009
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="installation.cli"><info><title>Command line installer</title><titleabbrev>CLI installer</titleabbrev></info>
+<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="installation.cli"><info><title>Command line installer (PEAR)</title><titleabbrev>CLI installer</titleabbrev></info>
    
    
    <warning xml:id="installation.cli.prerequesite"><info><title>Prerequisites</title></info>

http://cvs.php.net/viewvc.cgi/peardoc/en/guide/users/installationpyrus.xml?view=markup&rev=1.1
Index: peardoc/en/guide/users/installationpyrus.xml
+++ peardoc/en/guide/users/installationpyrus.xml
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="installationpyrus">
  <info>
   <title>Installation (Pyrus)</title>
   <author><personname><firstname>Gregory</firstname><surname>Beaver</surname></personname></author>
   <date>2009-06-17</date>
  </info>

  <simpara>
   This chapter describes how to install Pyrus, the package manager for PEAR2 and PHP 5.3+.
  </simpara>

  &guide.users.installationpyrus.introduction;
 </chapter>

http://cvs.php.net/viewvc.cgi/peardoc/en/guide/users/installationpyrus/introduction.xml?view=markup&rev=1.1
Index: peardoc/en/guide/users/installationpyrus/introduction.xml
+++ peardoc/en/guide/users/installationpyrus/introduction.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="installationpyrus.introduction">
    <info><title>Introduction: it's simple</title></info>

   <para>
    Installing Pyrus is much simpler than installing PEAR.  Installing PEAR
    requires downloading a separate installation and installing PEAR before you
    can use it to install any packages.
   </para>
   <para>
    To install pyrus, you must follow two simple steps:
    <orderedlist>
     <listitem>
      <simpara>
       Install PHP 5.3.0 or newer.  Pyrus needs the phar, simplexml, libxml2,
       spl and pcre extensions in order to work.  Fortunately, these are all
       enabled by default in PHP 5.3.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       download pyrus.phar from the pear2.php.net website front page
      </simpara>
     </listitem>
    </orderedlist>
    That's it, pyrus has no external dependencies.  Using Pyrus is also simple,
    one simply passes it to the command-line interface (CLI) like so:
   </para>
   <para>
    <screen>
     <![CDATA[
php pyrus.phar install packagename
     ]]>
    </screen>
   </para>
   <para>
    The first time pyrus is run on your system, it will ask where you would like
    to install packages.  After this, one can simply use it.
   </para>
   <para>
    To match PEAR, it is also possible to create a convenience script for
    accessing pyrus.  Here is a sample script for unix systems:
   </para>
   <para>
    <programlisting role="script">
     <![CDATA[
#!/bin/bash
/usr/local/bin/php -dphar.readonly=0 /home/username/pyrus.phar $*
     ]]>
    </programlisting>
   </para>
   <para>
    If your system has open_basedir enabled, the script should instead look like:
   </para>
   <para>
    <programlisting role="script">
     <![CDATA[
#!/bin/bash
/usr/local/bin/php -dphar.readonly=0 -dopen_basedir= -dsafe_mode= /home/username/pyrus.phar $*
     ]]>
    </programlisting>
   </para>
   <para>
    Windows users can create a batch file similar to the unix script named pyrus.bat:
   </para>
   <para>
    <programlisting role="script">
     <![CDATA[
@ECHO OFF
C:\php5\php -dphar.readonly=0 -dopen_basedir= -dsafe_mode= C:\php5\pyrus.phar %*
     ]]>
    </programlisting>
   </para>
   <para>
    Place the shell script (on unix) or batch file (on windows) in your path,
    and then you can run commands like so:
   </para>
   <para>
    <screen>
     <![CDATA[
pyrus install packagename
     ]]>
    </screen>
   </para>
  </section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/about.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/about.xml
+++ peardoc/en/pyrus/about.xml
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.about">
  <info>
   <title>Pyrus</title>
   <author><personname><firstname>Gregory</firstname><surname>Beaver</surname></personname></author>
   <date>2009-06-16</date>
  </info>

  <simpara>
   About Pyrus, the PEAR Installer for PHP 5.3+.  This documentation is a work in progress.
  </simpara>

  &pyrus.differences.frompear;
  &pyrus.differences.postinstallscripts;
  &pyrus.differences.customroles;
  &pyrus.differences.customtasks;
 </chapter>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/developers.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/developers.xml
+++ peardoc/en/pyrus/developers.xml
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.developers">
  <info>
   <title>Developer Tools for Pyrus</title>
   <author><personname><firstname>Gregory</firstname><surname>Beaver</surname></personname></author>
   <date>2009-06-16</date>
  </info>

  <simpara>
   How to use Pyrus to develop packages for installation by Pyrus.  This documentation is a work in progress.
  </simpara>

  &pyrus.developers.pear2;
  &pyrus.developers.pear;
  &pyrus.developers.pecl;
 </chapter>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/plugins.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/plugins.xml
+++ peardoc/en/pyrus/plugins.xml
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.plugins">
  <info>
   <title>Creating plugins for Pyrus</title>
   <author><personname><firstname>Gregory</firstname><surname>Beaver</surname></personname></author>
   <date>2009-06-16</date>
  </info>

  <simpara>
   How to create plugins for pyrus.  This documentation is a work in progress.
  </simpara>

  &pyrus.plugins.command;
  &pyrus.plugins.role;
  &pyrus.plugins.task;
 </chapter>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/developers/pear.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/developers/pear.xml
+++ peardoc/en/pyrus/developers/pear.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.developers.pear">
 <info><title>Using Pyrus to create PEAR packages</title></info>

 <section xml:id="pyrus.developers.pear.intro">
  <info><title>Introduction</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/developers/pear2.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/developers/pear2.xml
+++ peardoc/en/pyrus/developers/pear2.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.developers.pear2">
 <info><title>Using Pyrus to create PEAR2 packages</title></info>

 <section xml:id="pyrus.developers.pear2.intro">
  <info><title>Introduction</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/developers/pecl.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/developers/pecl.xml
+++ peardoc/en/pyrus/developers/pecl.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.developers.pecl">
 <info><title>Using Pyrus to create PECL packages</title></info>

 <section xml:id="pyrus.developers.pecl.intro">
  <info><title>Introduction</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/differences/customroles.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/differences/customroles.xml
+++ peardoc/en/pyrus/differences/customroles.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.differences.customroles">
 <info><title>Pyrus Custom File Roles: differences from PEAR</title></info>

 <section xml:id="pyrus.differences.customroles.overview">
  <info><title>Overview</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/differences/customtasks.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/differences/customtasks.xml
+++ peardoc/en/pyrus/differences/customtasks.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.differences.customtasks">
 <info><title>Pyrus Custom File Tasks: differences from PEAR</title></info>

 <section xml:id="pyrus.differences.customtasks.overview">
  <info><title>Overview</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/differences/frompear.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/differences/frompear.xml
+++ peardoc/en/pyrus/differences/frompear.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.differences.frompear">
 <info><title>Pyrus: Improvements from the PEAR Installer</title></info>

 <section xml:id="pyrus.differences.frompear.overview">
  <info><title>Overview</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/differences/postinstallscripts.xml?view=markup&rev=1.1
Index: peardoc/en/pyrus/differences/postinstallscripts.xml
+++ peardoc/en/pyrus/differences/postinstallscripts.xml
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.differences.postinstallscripts">
 <info><title>Pyrus Post-install scripts: differences from PEAR</title></info>

 <section xml:id="pyrus.differences.postinstallscripts.overview">
  <info><title>Overview</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

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

 <section xml:id="pyrus.plugins.command.intro">
  <info><title>Introduction</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

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

 <section xml:id="pyrus.plugins.role.intro">
  <info><title>Introduction</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>

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

 <section xml:id="pyrus.plugins.task.intro">
  <info><title>Introduction</title></info>
  <para>This is a work in progress.</para>
 </section>
</section>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.