svn: /pear/peardoc/trunk/en/pyrus/ commands/generateext.xml commands/generatepear2.xml commands.xml

saltybeagle                              Wed, 05 Aug 2009 21:46:09 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=286856

Log:
Start docs for generate-ext and generate-pear2.

Changed paths:
    A   pear/peardoc/trunk/en/pyrus/commands/generateext.xml
    A   pear/peardoc/trunk/en/pyrus/commands/generatepear2.xml
    U   pear/peardoc/trunk/en/pyrus/commands.xml

Added: pear/peardoc/trunk/en/pyrus/commands/generateext.xml
===================================================================
--- pear/peardoc/trunk/en/pyrus/commands/generateext.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/pyrus/commands/generateext.xml	2009-08-05 21:46:09 UTC (rev 286856)
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.commands.generateext">
+ <info><title>generate-ext - Create the subversion source layout for a new PHP extension that is PECL-ready</title></info>
+
+ <section xml:id="pyrus.commands.generateext.intro">
+  <info><title>Introduction</title></info>
+  <para>
+   The <literal>generate-pecl</literal> command is used to create a bare
+   skeleton for a new PECL package or PHP extension as it will reside in
+   Subversion. This is designed to provide all of the functionality of the
+   ext_skel command but also generates a package.xml and other files that can
+   be used to automatically update for a release.
+  </para>
+  <para>
+   One arguments is accepted, <literal>extension</literal>.
+  </para>
+  <para>
+  This command automatically creates class definitions as well as ZEND_ARG_INFO
+  for parameters to provide useful reflection to your extension's users.
+  </para>
+ </section>
+ <section xml:id="pyrus.commands.generateext.extension">
+  <title>extension</title>
+  <para>
+   The <literal>extension</literal> argument is the name of the package to create
+   a skeleton for. This is used as the directory name and as the extension name
+   used within files related to creating a PECL package.
+  </para>
+ </section>
+</section>

Added: pear/peardoc/trunk/en/pyrus/commands/generatepear2.xml
===================================================================
--- pear/peardoc/trunk/en/pyrus/commands/generatepear2.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/pyrus/commands/generatepear2.xml	2009-08-05 21:46:09 UTC (rev 286856)
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.commands.generatepear2">
+ <info><title>generate-pear2 - Create the subversion source layout for a PEAR2 package</title></info>
+
+ <section xml:id="pyrus.commands.generatepear2.intro">
+  <info><title>Introduction</title></info>
+  <para>
+   The <literal>generate-pear2</literal> command is used to create a bare
+   skeleton for a new PEAR2 package as it will reside in Subversion. It
+   creates everything needed except the source code.
+  </para>
+  <para>
+   Two arguments are accepted, <literal>package</literal> and optionally
+   <literal>channel</literal>.
+  </para>
+ </section>
+ <section xml:id="pyrus.commands.generatepear2.package">
+  <title>package</title>
+  <para>
+   The <literal>package</literal> argument is the name of the package to create
+   a skeleton for. This is used as the directory name and as the package name
+   used within files related to creating a PEAR2 package.
+  </para>
+  <para>
+   If <literal>MyPackage</literal> is passed, a directory will be created in
+   the current working directory titled <literal>MyPackage</literal>, with
+   subdirectories for branches, tags, and trunk. All the required packaging
+   files will be within the <literal>trunk</literal> directory, and you can
+   place your code within the <literal>MyPackage/trunk/src/MyPackage/Main.php</literal>
+   file.
+  </para>
+  <note>
+   <para>
+    <literal>PEAR2_MyPackage</literal> will be the name of your package if
+    <literal>MyPackage</literal> is passed as the package name.
+   </para>
+  </note>
+ </section>
+ <section xml:id="pyrus.commands.generatepear2.channel">
+  <title>channel</title>
+  <para>
+   The <literal>channel</literal> argument defaults to pear2.php.net.
+  </para>
+ </section>
+</section>

Modified: pear/peardoc/trunk/en/pyrus/commands.xml
===================================================================
--- pear/peardoc/trunk/en/pyrus/commands.xml	2009-08-05 21:25:39 UTC (rev 286855)
+++ pear/peardoc/trunk/en/pyrus/commands.xml	2009-08-05 21:46:09 UTC (rev 286856)
@@ -34,6 +34,8 @@
   &pyrus.commands.mypear;

   &pyrus.commands.runphpt;
+  &pyrus.commands.generatepear2;
+  &pyrus.commands.generateext;
   &pyrus.commands.make;
   &pyrus.commands.package;