cvs: peardoc /en/guide/developers release.xml
| From: | Martin Jansen | Date: | Sun, 21 Sep 2003 09:50:24 +0000 |
| Subject: | cvs: peardoc /en/guide/developers release.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-1534@lists.php.net to get a copy of this message | ||
mj Sun Sep 21 05:50:24 2003 EDT
Modified files:
/peardoc/en/guide/developers release.xml
Log:
* Whitespace changes
Index: peardoc/en/guide/developers/release.xml diff -u peardoc/en/guide/developers/release.xml:1.6 peardoc/en/guide/developers/release.xml:1.7 --- peardoc/en/guide/developers/release.xml:1.6 Mon Aug 4 04:51:12 2003 +++ peardoc/en/guide/developers/release.xml Sun Sep 21 05:50:24 2003 @@ -1,117 +1,117 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> -<chapter id="developers.release"> - <docinfo> - <author> - <firstname>Tal</firstname> - <surname>Peer</surname> - </author> - <date>2003-03-20</date> - </docinfo> - <title>Releasing A Package</title> - <subtitle>The steps required from package maintainers to release a - package.</subtitle> - - <sect1 id="developers.release.prerequisites"> - <title>Prerequisites</title> - <para> - The first step you must perform, is to check that your package conforms to - the &link.coding-standards;. After that, you need to make sure the package - is approved by the PEAR community (currently this means that you get five - votes (+1s) as replies to your package submission mail). - </para> - - <para> - After you have received the sufficient amount of votes and your package is - standards-compliant, you should ask for a PEAR website account by using the - form at <ulink url="&url.pear.account.new;">&url.pear.account.new;</ulink>. - After the account has been created, you can proceed with the next step. - </para> - </sect1> - - <sect1 id="developers.release.validating"> - <title>Validating The Package Definition File</title> - <para> - Next, you should check the package definition file - (<filename>package.xml</filename>) for validity. This is done by running the - command: <command>pear package-validate package.xml</command>. Fix the - errors and warnings, if any, and proceed to the next step. - </para> - <note> + <chapter id="developers.release"> + <docinfo> + <author> + <firstname>Tal</firstname> + <surname>Peer</surname> + </author> + <date>2003-03-20</date> + </docinfo> + <title>Releasing A Package</title> + <subtitle>The steps required from package maintainers to release a + package.</subtitle> + + <sect1 id="developers.release.prerequisites"> + <title>Prerequisites</title> + <para> + The first step you must perform, is to check that your package conforms to + the &link.coding-standards;. After that, you need to make sure the package + is approved by the PEAR community (currently this means that you get five + votes (+1s) as replies to your package submission mail). + </para> + + <para> + After you have received the sufficient amount of votes and your package is + standards-compliant, you should ask for a PEAR website account by using the + form at <ulink url="&url.pear.account.new;">&url.pear.account.new;</ulink>. + After the account has been created, you can proceed with the next step. + </para> + </sect1> + + <sect1 id="developers.release.validating"> + <title>Validating The Package Definition File</title> + <para> + Next, you should check the package definition file + (<filename>package.xml</filename>) for validity. This is done by running the + command: <command>pear package-validate package.xml</command>. Fix the + errors and warnings, if any, and proceed to the next step. + </para> + <note> + <para> + <command>pear pv package.xml</command> is an easy alias to the <command> + pear package-validate package.xml</command> command. + </para> + </note> + <note> + <para> + For help with writing the package definition file see the <link + linkend="developers.packagedef">package definition file + description</link>. + </para> + </note> + </sect1> + + <sect1 id="developers.release.packaging"> + <title>Packaging The Release Tarball</title> + <para> + Now that your package has a valid package definition file, you can package + the release tarball. Cd to the top-level directory of the package and run: + <command>pear package <package definition XML file></command> + This will create the release tarball (gzipped if zlib support is present) + that will be used later to upload the new release. + </para> + + <note> <para> - <command>pear pv package.xml</command> is an easy alias to the <command> - pear package-validate package.xml</command> command. + If your package defintion XML file is called package.xml you do not need + to append it to the <command>pear package</command> command. </para> - </note> - <note> + </note> + + <para> + Next, you should install the package locally by running: <command>pear + install <file></command> (file is the tarball you just packaged). + This is done to ensure that the package definition file is not only + valid-xml but also contains valid info. You should manually check that + every file is installed in the correct place. If your package contains + test scripts, which is highly recommended, you should run them. + </para> + <para> - For help with writing the package definition file see the <link - linkend="developers.packagedef">package definition file - description</link>. - </para> - </note> - </sect1> - - <sect1 id="developers.release.packaging"> - <title>Packaging The Release Tarball</title> - <para> - Now that your package has a valid package definition file, you can package - the release tarball. Cd to the top-level directory of the package and run: - <command>pear package <package definition XML file></command> - This will create the release tarball (gzipped if zlib support is present) - that will be used later to upload the new release. - </para> - - <note> - <para> - If your package defintion XML file is called package.xml you do not need - to append it to the <command>pear package</command> command. - </para> - </note> - - <para> - Next, you should install the package locally by running: <command>pear - install <file></command> (file is the tarball you just packaged). - This is done to ensure that the package definition file is not only - valid-xml but also contains valid info. You should manually check that - every file is installed in the correct place. If your package contains - test scripts, which is highly recommended, you should run them. - </para> - - <para> - If anything fails at this stage, correct it and re-package and re-test. - When everything seems OK, proceed. - </para> - </sect1> - - <sect1 id="developers.release.web"> - <title>Releasing The Package Through The Web Interface</title> - <para> - First, you should login to the PEAR website using the account you've been - given (see the first step). - </para> + If anything fails at this stage, correct it and re-package and re-test. + When everything seems OK, proceed. + </para> + </sect1> + + <sect1 id="developers.release.web"> + <title>Releasing The Package Through The Web Interface</title> + <para> + First, you should login to the PEAR website using the account you've been + given (see the first step). + </para> - <para> - If this is the first release of your package, you have to first register it. - Registration is done through the form at <ulink - url="&url.pear.package.new;">&url.pear.package.new;</ulink>. - If you are in doubt about the category to choose, consult the - community (preferably through the pear-dev mailing list). - </para> - - <para> - Now, finally, you can release your package. This is done again - using the convenient web interface. Use the form at - <ulink url="&url.pear.package.upload;">&url.pear.package.upload;</ulink>. - </para> - - <para> - That's it! Your package has been released, an announcement has been - sent to the mailing lists and everyone is happy :). - </para> - </sect1> -</chapter> + <para> + If this is the first release of your package, you have to first register it. + Registration is done through the form at <ulink + url="&url.pear.package.new;">&url.pear.package.new;</ulink>. + If you are in doubt about the category to choose, consult the + community (preferably through the pear-dev mailing list). + </para> + + <para> + Now, finally, you can release your package. This is done again + using the convenient web interface. Use the form at + <ulink url="&url.pear.package.upload;">&url.pear.package.upload;</ulink>. + </para> + + <para> + That's it! Your package has been released, an announcement has been + sent to the mailing lists. + </para> + </sect1> + </chapter> <!-- Keep this comment at the end of the file Local variables:
Index: peardoc/en/guide/developers/release.xml diff -u peardoc/en/guide/developers/release.xml:1.6 peardoc/en/guide/developers/release.xml:1.7 --- peardoc/en/guide/developers/release.xml:1.6 Mon Aug 4 04:51:12 2003 +++ peardoc/en/guide/developers/release.xml Sun Sep 21 05:50:24 2003 @@ -1,117 +1,117 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> -<chapter id="developers.release"> - <docinfo> - <author> - <firstname>Tal</firstname> - <surname>Peer</surname> - </author> - <date>2003-03-20</date> - </docinfo> - <title>Releasing A Package</title> - <subtitle>The steps required from package maintainers to release a - package.</subtitle> - - <sect1 id="developers.release.prerequisites"> - <title>Prerequisites</title> - <para> - The first step you must perform, is to check that your package conforms to - the &link.coding-standards;. After that, you need to make sure the package - is approved by the PEAR community (currently this means that you get five - votes (+1s) as replies to your package submission mail). - </para> - - <para> - After you have received the sufficient amount of votes and your package is - standards-compliant, you should ask for a PEAR website account by using the - form at <ulink url="&url.pear.account.new;">&url.pear.account.new;</ulink>. - After the account has been created, you can proceed with the next step. - </para> - </sect1> - - <sect1 id="developers.release.validating"> - <title>Validating The Package Definition File</title> - <para> - Next, you should check the package definition file - (<filename>package.xml</filename>) for validity. This is done by running the - command: <command>pear package-validate package.xml</command>. Fix the - errors and warnings, if any, and proceed to the next step. - </para> - <note> + <chapter id="developers.release"> + <docinfo> + <author> + <firstname>Tal</firstname> + <surname>Peer</surname> + </author> + <date>2003-03-20</date> + </docinfo> + <title>Releasing A Package</title> + <subtitle>The steps required from package maintainers to release a + package.</subtitle> + + <sect1 id="developers.release.prerequisites"> + <title>Prerequisites</title> + <para> + The first step you must perform, is to check that your package conforms to + the &link.coding-standards;. After that, you need to make sure the package + is approved by the PEAR community (currently this means that you get five + votes (+1s) as replies to your package submission mail). + </para> + + <para> + After you have received the sufficient amount of votes and your package is + standards-compliant, you should ask for a PEAR website account by using the + form at <ulink url="&url.pear.account.new;">&url.pear.account.new;</ulink>. + After the account has been created, you can proceed with the next step. + </para> + </sect1> + + <sect1 id="developers.release.validating"> + <title>Validating The Package Definition File</title> + <para> + Next, you should check the package definition file + (<filename>package.xml</filename>) for validity. This is done by running the + command: <command>pear package-validate package.xml</command>. Fix the + errors and warnings, if any, and proceed to the next step. + </para> + <note> + <para> + <command>pear pv package.xml</command> is an easy alias to the <command> + pear package-validate package.xml</command> command. + </para> + </note> + <note> + <para> + For help with writing the package definition file see the <link + linkend="developers.packagedef">package definition file + description</link>. + </para> + </note> + </sect1> + + <sect1 id="developers.release.packaging"> + <title>Packaging The Release Tarball</title> + <para> + Now that your package has a valid package definition file, you can package + the release tarball. Cd to the top-level directory of the package and run: + <command>pear package <package definition XML file></command> + This will create the release tarball (gzipped if zlib support is present) + that will be used later to upload the new release. + </para> + + <note> <para> - <command>pear pv package.xml</command> is an easy alias to the <command> - pear package-validate package.xml</command> command. + If your package defintion XML file is called package.xml you do not need + to append it to the <command>pear package</command> command. </para> - </note> - <note> + </note> + + <para> + Next, you should install the package locally by running: <command>pear + install <file></command> (file is the tarball you just packaged). + This is done to ensure that the package definition file is not only + valid-xml but also contains valid info. You should manually check that + every file is installed in the correct place. If your package contains + test scripts, which is highly recommended, you should run them. + </para> + <para> - For help with writing the package definition file see the <link - linkend="developers.packagedef">package definition file - description</link>. - </para> - </note> - </sect1> - - <sect1 id="developers.release.packaging"> - <title>Packaging The Release Tarball</title> - <para> - Now that your package has a valid package definition file, you can package - the release tarball. Cd to the top-level directory of the package and run: - <command>pear package <package definition XML file></command> - This will create the release tarball (gzipped if zlib support is present) - that will be used later to upload the new release. - </para> - - <note> - <para> - If your package defintion XML file is called package.xml you do not need - to append it to the <command>pear package</command> command. - </para> - </note> - - <para> - Next, you should install the package locally by running: <command>pear - install <file></command> (file is the tarball you just packaged). - This is done to ensure that the package definition file is not only - valid-xml but also contains valid info. You should manually check that - every file is installed in the correct place. If your package contains - test scripts, which is highly recommended, you should run them. - </para> - - <para> - If anything fails at this stage, correct it and re-package and re-test. - When everything seems OK, proceed. - </para> - </sect1> - - <sect1 id="developers.release.web"> - <title>Releasing The Package Through The Web Interface</title> - <para> - First, you should login to the PEAR website using the account you've been - given (see the first step). - </para> + If anything fails at this stage, correct it and re-package and re-test. + When everything seems OK, proceed. + </para> + </sect1> + + <sect1 id="developers.release.web"> + <title>Releasing The Package Through The Web Interface</title> + <para> + First, you should login to the PEAR website using the account you've been + given (see the first step). + </para> - <para> - If this is the first release of your package, you have to first register it. - Registration is done through the form at <ulink - url="&url.pear.package.new;">&url.pear.package.new;</ulink>. - If you are in doubt about the category to choose, consult the - community (preferably through the pear-dev mailing list). - </para> - - <para> - Now, finally, you can release your package. This is done again - using the convenient web interface. Use the form at - <ulink url="&url.pear.package.upload;">&url.pear.package.upload;</ulink>. - </para> - - <para> - That's it! Your package has been released, an announcement has been - sent to the mailing lists and everyone is happy :). - </para> - </sect1> -</chapter> + <para> + If this is the first release of your package, you have to first register it. + Registration is done through the form at <ulink + url="&url.pear.package.new;">&url.pear.package.new;</ulink>. + If you are in doubt about the category to choose, consult the + community (preferably through the pear-dev mailing list). + </para> + + <para> + Now, finally, you can release your package. This is done again + using the convenient web interface. Use the form at + <ulink url="&url.pear.package.upload;">&url.pear.package.upload;</ulink>. + </para> + + <para> + That's it! Your package has been released, an announcement has been + sent to the mailing lists. + </para> + </sect1> + </chapter> <!-- Keep this comment at the end of the file Local variables: