cvs: pear /CodeGen_MySQL_UDF/docs manual.xml

hholzgra Thu Feb 9 22:29:20 2006 UTC Modified files: /pear/CodeGen_MySQL_UDF/docs manual.xml Log: installation part updated http://cvs.php.net/viewcvs.cgi/pear/CodeGen_MySQL_UDF/docs/manual.xml?r1=1.3&r2=1.4&diff_format=u Index: pear/CodeGen_MySQL_UDF/docs/manual.xml diff -u pear/CodeGen_MySQL_UDF/docs/manual.xml:1.3 pear/CodeGen_MySQL_UDF/docs/manual.xml:1.4 --- pear/CodeGen_MySQL_UDF/docs/manual.xml:1.3 Sat Jan 14 00:53:31 2006 +++ pear/CodeGen_MySQL_UDF/docs/manual.xml Thu Feb 9 22:29:20 2006 @@ -20,7 +20,7 @@ <para> The code generated by <filename>udf-gen</filename> is designed to work with MySQL versions 3.23, 4.0, 4.1 and 5.0 without modifications (although - it is usually to compile it for a specific server version). + it is usually necessary to compile it for a specific server version). </para> </section> @@ -36,32 +36,70 @@ <section> <title>Installation</title> + <para> + <literal>CodeGen_MySQL_UDF</literal> is available in PEAR, the + PHP Extension and Application Repository, on <literal>http://pear.php.net/</literal>. + </para> <section> <title>Online installation</title> <para> - The packages has not yet been accepted by PEAR (its in voting stage - right now) so online installation is not yet possible. + Online installation using the PEAR installer is the easiest way + to install <literal>CodeGen_MySQL_UDF</literal>, just issue the + following command: + </para> + <programlisting> +pear install -o CodeGen_MySQL_UDF + </programlisting> + <para> + The PEAR installer will download and install the package itself + and all packages that it depends on. </para> </section> <section> <title>Installing from package files</title> <para> - A test package is available at - <literal>http://hartmut.homeip.net/CodeGen-MySQL-UDF-0.9.0dev.tgz</literal>. - The package depends on <literal>CodeGen</literal> so this needs to be - available in your local PEAR installation before you can install the - test package. + When installing from package files downloaded from <literal>pear.php.net</literal> + you have to resolve dependencies yourself. Currently <literal>CodeGen_PECL</literal> + depends on two other PEAR packages: <literal>Console_Getopt</literal>, which is part + of the PEAR base installation, <literal>CodeGen</literal>, the code generator + base package, and <literal>CodeGen_MySQL</literal>, the base package for MySQL + specific code generators. You need to download all three packages for installation. + The actual installation is once again performed by the PEAR installer: </para> + <programlisting> +pear install CogeGen-0.9.0.tgz +pear install CogeGen_MySQL-0.9.0.tgz +pear install CogeGen_MySQL-UDF-0.9.0.tgz + </programlisting> </section> <section> <title>Installing from PEAR CVS</title> <para> - The package is not yet available from PEAR CVS as has not yet passed - the proposal process. + You can also install CodeGen_MySQL_UDF snapshots from PEAR CVS. CVS snapshots may + include features not yet available in any release package, but the code in + CVS may not be as well tested as the release packages (or even broken at + times). Be warned, your milage may vary. Use the following sequence of + commands in your PEAR CVS checkout to install the latest + <literal>CodeGen_MySQL_UDF</literal> snapshot: </para> + <programlisting> +cd pear +cd CodeGen +cvs update +pear install -f package.xml +cd .. +cd CodeGen_MySQL +cvs update +pear install -f package.xml +cd .. +cd CodeGen_MySQL_UDF +cvs update +pear install -f package.xml +cd .. + </programlisting> </section> </section>