Getting the source - using WinCVS

[Daniel Wang]

... because Daniel Wang could not figure it out ...

(note: I cannot verify the information below because my WinCVS is acting funky)

Q How do I view the source?

LXR, Tarball, CVS

Q Where to get WinCVS

A http://www.wincvs.org/

Q Special note about installing WinCVS

A none. Installation is straight forward.

Q Getting started

A When you first start WinCVS, you will be prompt a dialog to create
one cvs repository.

In the General tab, change `authentication' from `local' to `pserver'.
Then paste the following line to `CVSROOT':

[EMAIL PROTECTED]:/cvsroot

In the CVS tab, set the home directory. This will be the directory to
store your cvs files. You may be prompted to create a new directory if
it does not already exist.

Q The interface

A The interface consist of three panes. The left pane is workspace
pane. It lists all folders under the current browse directory.
Select the View menu, choose Browse location, choose `change'
to browse a different directory.

On the right is the browse pane. It list all files and folder under
the active folder in the workspace pane. Files and folders are marked.
CVS files are unmarked [???]. Non-cvs files are marked with a question
mark. A cvs file that you have modified are marked red. A cvs file
on commit queue (e.g. marked added but not confirmed) is marked [???].

A cvs folder has a check mark. A non-cvs folder has no check mark.

On the bottom is the Output pane. It is basically a history of current
and past cvs operations.

Q Log in to mozilla.org cvs

A Go to Admin menu, and choose `Login...'.

In the dialog prompt, go to the general tab and verify the cvs
information. Click OK to log in.

You will be prompt to enter the password. Enter `anonymous'

If you log in successfully, you will see the following in the
output pane:

***** CVS exited normally with code 0 *****

Whenever you see code 0, it means the operation is successful. If
you see a code 1, then the operation either aborted or failed.

Q Check out the entire Mozilla source code

A To check out the entire Mozilla source code, choose the `Create'
menu, and then `Checkout module...'

In the dialog prompt, enter the Module name in the `Checkout settings'
tab. In mozilla.org /cvsroot path, there is only one module:
`mozilla'. Type in `mozilla'.

In the same tab, also check your local folder setting. All Mozilla
source files you check out will be placed in the `mozilla' subfolder
in your cvs local folder. If you want to change the default module
folder name, check `override' and change the checkout name from
`mozilla' to something else.

Navigate to the General tab and verify cvs server information. Click
Ok to checkout the entire Mozilla source code.

Q Check out a some source files

A To check out a directory or a file, just type in the cvs file location
in the module name, for example,
`mozilla/browser/components/bookmarks/'

mozilla.org cvs server does not allow file listing (the ls command),
so to know the specific location of a file (or directory), you have
to use LXR.

If you want all files in a folder but excluding contents in
sub-folders, check the `Do not recurse' option.

Q Organize your files

A You can have more than one repositories, for example, one for Mozilla
source code, and one for mozdev projects. To better manage your code,
you should have a different cvs home directory each repository.

Q I cannot change the files I checked out!

A By default, files checked out are marked read only. This is to prevent
accidental change to source files. To save the changes you made to
your file, remove the read-only tag.

If you don't want to check out files as read-only, when you check out
files or synchronize (update) your local copies with cvs copies,
in the dialog prompt uncheck the 'Checkout read-only' option in the
Globals tab.

Q Committing changes

A If you have write access to your cvs repository, you can commit
changes to the source tree. Files that you have changed since they
are lasted checked out or synchronized have red icons. Select the
files you want to upload, choose the `Modify' menu and choose
`Commit' to commit the changes.

Q Adding new files

A ????

Q Deleting files

A Removing a file from cvs is very tricky and requires special
previlege. So be mindful of what you are adding to the source
tree.

Q Viewing diff

A ????

Q mozdev.org stuff

Q ????