cvs: peardoc /en/channels scs.xml /en/channels/scs commands.xml intro.xml /en/channels/scs/commands addcategory.xml addmaintainer.xml create.xml release.xml update.xml

saltybeagle		Fri Jul  3 14:18:19 2009 UTC

  Added files:                 
    /peardoc/en/channels/scs/commands	addcategory.xml update.xml 
                                     	addmaintainer.xml release.xml 
                                     	create.xml 
    /peardoc/en/channels/scs	commands.xml 

  Modified files:              
    /peardoc/en/channels/scs	intro.xml 
    /peardoc/en/channels	scs.xml 
  Log:
  Add start of some docs on SimpleChannelServer
  
http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/intro.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/channels/scs/intro.xml
diff -u peardoc/en/channels/scs/intro.xml:1.1 peardoc/en/channels/scs/intro.xml:1.2
--- peardoc/en/channels/scs/intro.xml:1.1	Wed Jul  1 19:18:31 2009
+++ peardoc/en/channels/scs/intro.xml	Fri Jul  3 14:18:19 2009
@@ -2,5 +2,27 @@
 <section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.intro">
  <info><title>Introduction to PEAR2_SimpleChannelServer</title></info>
 
- <para>This is a work in progress.</para>
+ <para>
+   The SimpleChannelServer package allows developers to create a 
+   PEAR compatible channel server to distribute packages. This channel server
+   is simple in that it only works with the local filesystem to create the 
+   necessary files for package distribution.
+ </para>
+ <note>
+  <para>
+   At a minimum, the ability to post files to the webspace where your channel
+   will be hosted.
+  </para>
+ </note>
+ <para>
+   It is possible to host your PEAR channel on webspace such as Google
+   Code, just use the webpath to the svn directory as your channel name,
+   and be sure to set the correct svn:mime-type on the xml files.
+ </para>
+ <para>
+    To get started, simply download the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://svn.pear.php.net/wsvn/PEARSVN/sandbox/SimpleChannelServer/pearscs.phar?op=file&amp;rev=0&amp;sc=0">pearscs.phar</link>
+    file to your local filesystem, and execute the <literal>pearscs.phar</literal> 
+    file with the <literal>create</literal> command. Then, build the rest of
+    the channel using the <link linkend="channels.scs.commands">other SimpleChannelServer commands</link>.
+ </para>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/channels/scs.xml
diff -u peardoc/en/channels/scs.xml:1.1 peardoc/en/channels/scs.xml:1.2
--- peardoc/en/channels/scs.xml:1.1	Wed Jul  1 19:18:31 2009
+++ peardoc/en/channels/scs.xml	Fri Jul  3 14:18:19 2009
@@ -11,4 +11,5 @@
   </para>
 
  &channels.scs.intro;
+ &channels.scs.commands;
  </chapter>

http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/commands/addcategory.xml?view=markup&rev=1.1
Index: peardoc/en/channels/scs/commands/addcategory.xml
+++ peardoc/en/channels/scs/commands/addcategory.xml
<?xml version="1.0" encoding="UTF-8"?>

http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/commands/update.xml?view=markup&rev=1.1
Index: peardoc/en/channels/scs/commands/update.xml
+++ peardoc/en/channels/scs/commands/update.xml
<?xml version="1.0" encoding="UTF-8"?>

http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/commands/addmaintainer.xml?view=markup&rev=1.1
Index: peardoc/en/channels/scs/commands/addmaintainer.xml
+++ peardoc/en/channels/scs/commands/addmaintainer.xml
<?xml version="1.0" encoding="UTF-8"?>

http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/commands/release.xml?view=markup&rev=1.1
Index: peardoc/en/channels/scs/commands/release.xml
+++ peardoc/en/channels/scs/commands/release.xml
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.create">
 <info><title>The release Command</title></info>
 <para>
    The <literal>release</literal> command releases a package to your PEAR
    channel.
 </para>
 <example>
    pearscs release MyPackage-1.0.0.tgz handle
 </example>
 <para>
   The file must be a valid PEAR package, and can be either the package.xml
   file, or a compressed and optionally signed .tgz file.
 </para>
 <para>
   The <literal>handle</literal> attribute should be a lead maintainer for the
   package, as who released this version will be stored within the channel's
   xml files.
 </para>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/commands/create.xml?view=markup&rev=1.1
Index: peardoc/en/channels/scs/commands/create.xml
+++ peardoc/en/channels/scs/commands/create.xml
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.create">
 <info><title>The create Command</title></info>
 <para>
    The <literal>create</literal> command creates a PEAR channel on the
    local filesystem, including the channel.xml file and the get and rest
    directories. This command assumes you are currently at the web root
    for the channel you wish to create, unless you pass the path to where the
    channel.xml file will be created. The local root can be a subdirectory
    off of your webserver, but you should be in that subdirectory when
    executing this command.
 </para>
 <example>
    pearscs create pear.example.com summary [alias] [./channel.xml]
 </example>
 <para>
   Required arguments are the channel name and channel summary.
   
   For example pear.example.com or can also be a subdirectory such as
   www.example.com/pear.
 </para>
 <para>
   The alias is a short name which can be used to refer to your PEAR channel.
   
   If one is not specified, SimpleChannelServer will attempt to create one for
   you.
   
 </para>
 <para>
  If the path to a channel.xml file is specified, the directory given will be
  used to create the channel.xml, get, and rest directories for the channel.
  If no path is specified, SimpleChannelServer will use the current directory.
 </para>
</section>

http://cvs.php.net/viewvc.cgi/peardoc/en/channels/scs/commands.xml?view=markup&rev=1.1
Index: peardoc/en/channels/scs/commands.xml
+++ peardoc/en/channels/scs/commands.xml
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands">
 <info><title>Commands Available In PEAR2_SimpleChannelServer</title></info>
 <para>
    The SimpleChannelServer command line script supports the following commands.
    <itemizedlist>
      <listitem>
        <para>
          <literal>create</literal> - Creates a channel
        </para>
      </listitem>
      <listitem>
        <para>
          <literal>release</literal> - Releases a package
        </para>
      </listitem>
      <listitem>
        <para>
          <literal>update</literal> - Updates an existing PEAR channel
        </para>
        <note>
          <para>
            This command will scan the /get/ directory for all packages, and
            release them.
          </para>
        </note>
      </listitem>
      <listitem>
        <para>
          <literal>add-maintainer</literal> - Adds a maintainer to the channel
        </para>
      </listitem>
      <listitem>
        <para>
          <literal>add-category</literal> - Adds a package category to the channel
        </para>
      </listitem>
    </itemizedlist>
  </para>
</section>