vmote 2003/03/24 17:34:46
Modified: src/documentation/content/xdocs/dev tools.xml
Log:
Add step-by-step for WinCVS downloads.
Revision Changes Path
1.2 +35 -5 xml-fop/src/documentation/content/xdocs/dev/tools.xml
Index: tools.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/dev/tools.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tools.xml 25 Mar 2003 00:30:18 -0000 1.1
+++ tools.xml 25 Mar 2003 01:34:46 -0000 1.2
@@ -9,12 +9,42 @@
<body>
<p>This page documents items that may be helpful to other developers,
especially to those who are new to FOP. Exhaustive treatment of these topics is better
suited to other fora, but the information presented here is intended to deal with
FOP-specific issues related to these tools, especially "gotchas", and to help
developers get jump-started.</p>
<section>
- <title>CVS</title>
- <p>You will need a CVS client to be able to gain access to the FOP
repository.</p>
- <p>To create a patch to be submitted for consideration to be committed, do
the following:</p>
+ <title>Concurrent Versions System (CVS)</title>
+ <p>Visit <link href="http://xml.apache.org/cvs.html";>Apache XML CVS
Repositories</link> for useful information.</p>
+ <p>You will need a CVS client to be able to gain access to the FOP
repository. For general CVS information, visit <link href="http://www.cvshome.org";>CVS
Home</link>. Nice GUI clients for Windows, Mac, and X(??) can be found at <link
href="http://www.wincvs.org";>WinCVS</link>.</p>
+ <p>Regardless of what platform you develop on, please be sure to submit
patches that use Unix line endings. If you are using WinCVS, check code out this way
by going to the Admin / Preferences menu item, clicking on the "Globals" tab, then
select the "Checkout text files with the Unix LF (0xa)" option. You will also need to
use an editor that supports opening and saving files using Unix line endings.</p>
+ <p>Step-by-step instructions for downloading FOP using WinCVS:</p>
<ul>
- <li><code>cd</code> to the directory above the "xml-fop" directory that was
created when you checked out the code. You can actually <code>cd</code> farther down
the directory tree if your changes do not comprehend the entire FOP directory
structure. However, don't go any deeper than will allow all of your changes to be
included in one "diff". Also, adjust</li>
- <li>Run: <code>cvs -q diff -wu xml-fop</code></li>
+ <li>Select "Create / Checkout Module" menu item.</li>
+ <li>“Checkout Settings” Tab:
+ <ul>
+ <li>“Enter the module name and path on the
server:”<br></br><code>xml-fop</code></li>
+ <li>“Local folder to checkout to:”<br></br>Enter your local
directory</li>
+ </ul>
+ </li>
+ <li>“Checkout Options” Tab
+ <ul>
+ <li>If you are checking out the trunk, unset all options.</li>
+ <li>If you are checking out the maintenance branch (currently
distributed code), check“By revision/tag/branch:” and enter
<code>fop-0_20_2-maintain</code>.</li>
+ </ul>
+ </li>
+ <li>“General” Tab
+ <ul>
+ <li>“Enter the CVSROOT:”<br></br><code>:pserver:[EMAIL
PROTECTED]:/home/cvspublic</code></li>
+ <li>“Authentication:”<br></br><code>“passwd” file on the cvs
server</code></li>
+ </ul>
+ </li>
+ <li>“Globals” Tab
+ <ul>
+ <li>check “Checkout text files with the Unix LF (Oxa)”</li>
+ </ul>
+ </li>
+ <li>Click "OK" and the download should begin.</li>
+ </ul>
+ <p>To create a patch to be submitted for consideration, do the following:</p>
+ <ul>
+ <li><code>cd</code> to a directory that contains all of the changes that
you wish to include in the patch. To comprehend the entire distribution,
<code>cd</code> to the directory above the "xml-fop" directory that was created when
you checked out the code.</li>
+ <li>Run: <code>cvs -q diff -wu <list of items to
diff></code><br></br>The <list of items to diff> is a space-separated list of
files and directories relative to the current directory that you wish to include in
the diff. For example, to include the entire distribution, assuming that you are in
the directory, above xml-fop, simply enter "xml-fop". This will recursively go through
the directories beneath xml-fop to diff each file.</li>
<li>If you are running WinCVS, select "Admin/Command Line" for a console in
which to key the above command.</li>
<li>On a Linux/Unix machine, you will want to redirect the output from the
above command into a file. If you are using GNU WinCVS, you can cut the output from
the console window and paste it into a file. The "-w" ignores whitespace differences.
The "-u" puts the diff in "universal" format. You may wish to use the "-N" option as
well, which is supposed to treat new files as if there were an old 0 byte file -- in
other words, it is supposed to include the new file in the patch. However, it only
operates on files that have been "add"ed to the CVS repository, which cannot be done
without commit access.</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
