cvs: phpdoc /howto tools.xml

techtonik Tue Mar 1 12:26:57 2005 EDT Modified files: /phpdoc/howto tools.xml Log: * try to explain why it is better to use cmdline cvs client in more realistic way =) + instructions for minimum working installation of cygwin packages + openjade instructions http://cvs.php.net/diff.php/phpdoc/howto/tools.xml?r1=1.21&r2=1.22&ty=u Index: phpdoc/howto/tools.xml diff -u phpdoc/howto/tools.xml:1.21 phpdoc/howto/tools.xml:1.22 --- phpdoc/howto/tools.xml:1.21 Tue Jul 27 20:16:31 2004 +++ phpdoc/howto/tools.xml Tue Mar 1 12:26:56 2005 @@ -220,12 +220,10 @@ <para> You need the same tools as on Linux. The very basic thing is a CVS client. You can find one simple command - line client here at the <ulink url="&url.cvs-win;">CVSHome.org</ulink> - Win32 download pool. We do not recommend GUI tools such - as WinCVS, because they can easily screw up the module - with files not intended to be there (eg. files with - uppercased names). The best is to use one command line - client, as this way you are in control. + line client here at the <ulink url="&url.cvs-win;">CVSHome.org</ulink>. + Although you can use GUI tools such as WinCVS or TortoiseCVS, + we provided instructions only for command line client in order + to keep this HOWTO short and simple. </para> <para> @@ -242,7 +240,7 @@ If you want to produce something viewable, or just would like to test the modified file before committing (recommended!), you need some more tools. To get it running on Windows, - you'll need these tools: + you'll need these: <itemizedlist> <listitem> @@ -269,21 +267,23 @@ You need to download and install the Cygwin tools. Just select the "Install now!" link and run the supplied <filename>setup.exe</filename>. It will guide you through - the process of installation. These tools are port of standard + the process of installation. These tools are ports of standard Unix tools like sed, awk, autoconf, make, perl, ... - for Windows. + for Windows. </para> <note> <para> Be aware, that cygwin is grown to be a very huge project and it includes many programs (such as postgres and apache) ported - to Windows, which are not needed for phpdoc. We are unable to - give you a list of needed components from cygwin (which you should - download and install), because the basic tools are interconnected, - and depend on each other. If you manage to find the smallest - needed installation, do not hesitate to contact us, and send the - solution to us. + to Windows, which are not needed for phpdoc. To install + minimal set of required packages select + <literal>autoconf</literal> and <literal>make</literal> + along with components, which are selected in setup by + default. You may also want to add <literal>cvs</literal> + to the installation list if you don't have CVS client yet. + Do not care about dependencies - they will be selected + automatically. </para> </note> @@ -329,7 +329,9 @@ <literal>ls</literal>, you should see <literal>phpdoc</literal> listed). Type <literal>mkdir phpdoc-tools</literal>, and then unzip Jade to - <literal>phpdoc-tools/jade</literal>. + <literal>phpdoc-tools/jade</literal>. If you chose openjade, + place files from <literal>bin/</literal> directory of + openjade archive to <literal>phpdoc-tools/openjade</literal>. </para> <para>