Use LCD_WHITE macro - this is defined for both greyscale and colour LCDs

[Rockbox.git] / www / cvs.t

#define _PAGE_ Accessing source code via CVS
#include "head.t"

<h2>Browsing the repository</h2>

<p>Just go <a href="/viewcvs.cgi/">here</a>.

<h2>Daily snapshots</h2>

<p>Every night at 6am CET, we build a source tarball and target .mod files
from the latest CVS code.  <a href="daily.shtml">Get them here</a>.

<h2>Downloading (checking out) the source</h2>

<p>You, obviously, need to have <a href="http://www.cvshome.org">CVS</a>
installed to do this.

<p>Here is a complete list of the available modules:

<ul>
<li>apps - the source code to the applications
<li>firmware - the source code to the firmware library
<li>gdb - the gdb stub to use for remote debugging
<li>tools - tools for building the firmware
<li>uisimulator - a user interface simulator for X11
<li>docs - project documentation
<li>www - the web page
</ul>

<p>We have a few other convenient aliases that gets several
modules at once for you:

<ul>
<li> rockbox - gets everything you need to compile and build rockbox for target
<li> rockbox-devel - like 'rockbox' but also includes simulators and gdb code
<li> rockbox-all - gets everything there is in CVS, all modules
<li> website - gets the www and docs modules
</ul>

<p>The examples below use the 'rockbox' module, since that is what most
people are interested in. 

<h3>Anonymous read-only checkout</h3>

<p>If you are not a registered developer, use this method.
When asked for a password, just press enter:

<p><tt>cvs -d:pserver:anonymous@rockbox.haxx.se:/cvsroot/rockbox login
<br>cvs -z3 -d:pserver:anonymous@rockbox.haxx.se:/cvsroot/rockbox co rockbox</tt>

<p>A "rockbox" directory will be created in your current directory, and all
the directories and source files go there.

<h3>Checkout with write access (for developers)</h3>

<p>For this, you need to be added to the writers list by Rockbox administrators. After that, you can login with your username:

<p><tt>cvs -d:pserver:<b>username</b>@rockbox.haxx.se:/cvsroot/rockbox login
<br>cvs -z3 -d:pserver:<b>username</b>@rockbox.haxx.se:/cvsroot/rockbox co rockbox</tt>

<h2>Checking in modifications</h2>

<p>CVS is a "no-reserve" version control system. This means that you work on your local files without first reserving them. Any conflicts with other developers are detected when you check-in, or "commit" as it's called in CVS:

<p><tt>cvs commit <b>filename</b></tt>

<p>This will start an editor and ask you to describe the changes you've made. If you want, you can use the -m command line option to specify the comment right there:

<p><tt>cvs commit -m "This is my change comment" <b>filename</b></tt>

<p><strong>Note:</strong> Before checking in modifications, test-build all targets (player, player-old, recorder, player-sim, recorder-sim) to make sure your changes don't break anything.

<h2>Updating your repository</h2>

<p>Since several people commit to the repository, you will need to periodically
synchronize your local files with the changes made by others.
This operation is called "update":

<p><tt>cvs update -dP</tt>

<p>The <b>-d</b> switch tells update to create any new directories that have been created the repository since last update.
<br>The <b>-P</b> switch tells update to delete files that have been removed in the repository.

<h2>Adding a new file</h2>

<p>Adding a file is very simple:

<p><tt>cvs add <b>filename</b></tt>

<p>If you are adding a binary file, you need to specify the -kb flag:

<p><tt>cvs add -kb <b>filename</b></tt>

<p>These changes, like any other change, has to be committed before they will be visible on the server.

<h2>Querying the status of your files</h2>

<p>Sometimes it is interesting to get a list of the status of your files versus
those on the remote repository. This is called "status":

<p><tt>cvs status</tt>

<p>The output from "status" can be rather verbose. You may want to filter it with grep:

<p><tt>cvs status | grep Status</tt>

<p>To only list files who differ from the server, filter again:

<p><tt>cvs status | grep Status | grep -v Up-to-date</tt>

<h2>Producing a diff of your changes</h2>

<p>If you want to see how your local files differ from the CVS repository,
you can ask CVS to show you:

<p><tt>cvs diff -u [files(s)]</tt>

<p>The <tt>-u</tt> selects the "unified" diff format, which is preferrable
when working with source code.

<h2>What Happens in the Repository?</h2>
<p>
 Subscribe to the rockbox-cvs list to get mails sent to you for every commit
 done to the repostory.
<p>
 To join this list, send a mail to majordomo@cool.haxx.se, with the following
 text in the body (no subject) "subscribe rockbox-cvs".
<p>
 <b>Note</b> that this may cause quite a few mails to get sent during periods
of intense development.

#include "foot.t"