cvs: peardoc /en/pyrus plugins.xml /en/pyrus/configuration/system bindir.xml cfgdir.xml datadir.xml docdir.xml extdir.xml phpbin.xml phpdir.xml phpini.xml phpprefix.xml phpsuffix.xml srcdir.xml testdir.xml wwwdir.xml
[email protected] ("Greg Beaver")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvscellog1246160484@cvsserver> |
cellog Sun Jun 28 03:41:24 2009 UTC
Modified files:
/peardoc/en/pyrus plugins.xml
/peardoc/en/pyrus/configuration/system bindir.xml cfgdir.xml
datadir.xml docdir.xml
extdir.xml phpbin.xml
phpdir.xml phpini.xml
phpprefix.xml phpsuffix.xml
srcdir.xml testdir.xml
wwwdir.xml
Log:
document system config variables for pyrus
cellog-20090628034124.txt
(text/plain, 11.5 KB)
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/plugins.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/plugins.xml
diff -u peardoc/en/pyrus/plugins.xml:1.1 peardoc/en/pyrus/plugins.xml:1.2
--- peardoc/en/pyrus/plugins.xml:1.1 Thu Jun 18 04:50:40 2009
+++ peardoc/en/pyrus/plugins.xml Sun Jun 28 03:41:24 2009
@@ -6,9 +6,11 @@
<date>2009-06-16</date>
</info>
- <simpara>
- How to create plugins for pyrus. This documentation is a work in progress.
- </simpara>
+ <para>
+ Pyrus defines three kinds of plugins: commands, file roles, and file tasks.
+ Commands add new commands to a frontend for Pyrus, file roles and file tasks
+ add new features to package.xml.
+ </para>
&pyrus.plugins.command;
&pyrus.plugins.role;
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/bindir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/bindir.xml
diff -u peardoc/en/pyrus/configuration/system/bindir.xml:1.1 peardoc/en/pyrus/configuration/system/bindir.xml:1.2
--- peardoc/en/pyrus/configuration/system/bindir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/bindir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,9 @@
<section xml:id="pyrus.configuration.system.bindir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ executable files (files with a <literal>script</literal> role) are installed
+ into <literal>bin_dir</literal>
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/cfgdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/cfgdir.xml
diff -u peardoc/en/pyrus/configuration/system/cfgdir.xml:1.1 peardoc/en/pyrus/configuration/system/cfgdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/cfgdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/cfgdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,10 @@
<section xml:id="pyrus.configuration.system.cfgdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Customizable configuration files (files with <literal>cfg</literal> role) are
+ installed into this directory. These files are intended to be manipulated
+ by the user, and Pyrus will not overwrite them if any changes have been made.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/datadir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/datadir.xml
diff -u peardoc/en/pyrus/configuration/system/datadir.xml:1.1 peardoc/en/pyrus/configuration/system/datadir.xml:1.2
--- peardoc/en/pyrus/configuration/system/datadir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/datadir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,15 @@
<section xml:id="pyrus.configuration.system.datadir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Files with roles <literal>data</literal>, <literal>customcommand</literal>,
+ <literal>customrole</literal> and <literal>customtask</literal> are installed
+ into the <literal>data_dir</literal> configuration variable.
+ </para>
+ <para>
+ In Pyrus, this is a pseudo-configuration variable: its value cannot be changed
+ without creating an entirely new repository. Data is always stored in the
+ directory <literal>data/</literal> relative to the location of the installation.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/docdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/docdir.xml
diff -u peardoc/en/pyrus/configuration/system/docdir.xml:1.1 peardoc/en/pyrus/configuration/system/docdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/docdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/docdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,7 @@
<section xml:id="pyrus.configuration.system.docdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>files with the <literal>doc</literal> role are installed into
+ <literal>doc_dir</literal>.</para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/extdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/extdir.xml
diff -u peardoc/en/pyrus/configuration/system/extdir.xml:1.1 peardoc/en/pyrus/configuration/system/extdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/extdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/extdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,9 @@
<section xml:id="pyrus.configuration.system.extdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Compiled extension files are installed into the <literal>ext_dir</literal>,
+ and files with role <literal>ext</literal>.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/phpbin.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/phpbin.xml
diff -u peardoc/en/pyrus/configuration/system/phpbin.xml:1.1 peardoc/en/pyrus/configuration/system/phpbin.xml:1.2
--- peardoc/en/pyrus/configuration/system/phpbin.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/phpbin.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,9 @@
<section xml:id="pyrus.configuration.system.phpbin.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ the <literal>php_bin</literal> configuration variable refers to the location
+ of PHP that should be used for installed executable scripts.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/phpdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/phpdir.xml
diff -u peardoc/en/pyrus/configuration/system/phpdir.xml:1.1 peardoc/en/pyrus/configuration/system/phpdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/phpdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/phpdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,14 @@
<section xml:id="pyrus.configuration.system.phpdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Files with roles <literal>php</literal> are installed
+ into the <literal>php_dir</literal> configuration variable.
+ </para>
+ <para>
+ In Pyrus, this is a pseudo-configuration variable: its value cannot be changed
+ without creating an entirely new repository. PHP files are always stored in the
+ directory <literal>php/</literal> relative to the location of the installation.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/phpini.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/phpini.xml
diff -u peardoc/en/pyrus/configuration/system/phpini.xml:1.1 peardoc/en/pyrus/configuration/system/phpini.xml:1.2
--- peardoc/en/pyrus/configuration/system/phpini.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/phpini.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,10 @@
<section xml:id="pyrus.configuration.system.phpini.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ the <literal>php_ini</literal> variable should be set to the location of
+ <literal>php.ini</literal> that is used by this installation, and is used
+ to automatically enable extensions on installation.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/phpprefix.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/phpprefix.xml
diff -u peardoc/en/pyrus/configuration/system/phpprefix.xml:1.1 peardoc/en/pyrus/configuration/system/phpprefix.xml:1.2
--- peardoc/en/pyrus/configuration/system/phpprefix.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/phpprefix.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,9 @@
<section xml:id="pyrus.configuration.system.phpprefix.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ This variable should be set to the value that <literal>--program-prefix</literal>
+ was set to when PHP was configured, and is used when building PECL extensions.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/phpsuffix.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/phpsuffix.xml
diff -u peardoc/en/pyrus/configuration/system/phpsuffix.xml:1.1 peardoc/en/pyrus/configuration/system/phpsuffix.xml:1.2
--- peardoc/en/pyrus/configuration/system/phpsuffix.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/phpsuffix.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,9 @@
<section xml:id="pyrus.configuration.system.phpsuffix.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ This variable should be set to the value that <literal>--program-suffix</literal>
+ was set to when PHP was configured, and is used when building PECL extensions.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/srcdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/srcdir.xml
diff -u peardoc/en/pyrus/configuration/system/srcdir.xml:1.1 peardoc/en/pyrus/configuration/system/srcdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/srcdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/srcdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,10 @@
<section xml:id="pyrus.configuration.system.srcdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Files with the <literal>src</literal> role are installed into
+ <literal>src_dir</literal>, and building of PECL packages
+ also happens in this directory.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/testdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/testdir.xml
diff -u peardoc/en/pyrus/configuration/system/testdir.xml:1.1 peardoc/en/pyrus/configuration/system/testdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/testdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/testdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,8 @@
<section xml:id="pyrus.configuration.system.testdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Files with <literal>test</literal> role are installed into this directory.
+ </para>
</section>
</section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/system/wwwdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/system/wwwdir.xml
diff -u peardoc/en/pyrus/configuration/system/wwwdir.xml:1.1 peardoc/en/pyrus/configuration/system/wwwdir.xml:1.2
--- peardoc/en/pyrus/configuration/system/wwwdir.xml:1.1 Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/system/wwwdir.xml Sun Jun 28 03:41:24 2009
@@ -4,6 +4,8 @@
<section xml:id="pyrus.configuration.system.wwwdir.intro">
<info><title>Introduction</title></info>
- <para>This is a work in progress.</para>
+ <para>
+ Files with <literal>www</literal> role are installed into this directory.
+ </para>
</section>
</section>