Setting up for editing withTortoiseCVS

I'm documenting one way of setting yourself up to edit files on the Internationalization subsite of the W3C site. Much of the early information here is copied pretty much straight from Jeremy Carroll's excellent advice.

Objective: Download and upload documents on the W3C site using TortoiseCVS.

Sofware to install:

  1. Putty
  2. TortoiseCVS (follow the installation instructions in the help file)

Jeremy describes a couple of alternatives: he proposes WinCVS as the CVS client (ie. instead of TortoiseCVS) and Hummingbird if you need to get through a firewall. See his document for more information about those. I haven't tried Hummingbird with TortoiseCVS.

Config instructions

1. Putty

You need at least:

putty.exe
plink.exe
puttygen.exe
pageant.exe

Update your path environment variable via start->settings->control panel->system->advanced->environment variables so it includes the directory where you downloaded these files.

2. Generate a public / private key pair

Start puttygen.exe. Press generate to generate the public / private key pair, and follow the instructions on moving the mouse in order to generate randomness. Use the default option for length. Once the key is generated, type in a pass phrase making sure that you will be able to remember this pass phrase later. Save the private key to a local directory.

Copy the public key from the puttygen window to a new text file in the directory. Ensure that the two files have names that allow you to remember them as the private key and public key pair.

To access the site, your W3C staff contact will need fill in a form requesting CVS access for you. The staff contact will need to add the public key to the form. (This application can be done once you have generated your keys. You will need your w3c cvs login name at step 4. This will be returned to you in the reply to the cvs access request).

3. Set up Pageant

Next you need to start pageant.exe. Right click on the icon in the Windows icon tray and select Add Key. Browse to and load in the key you generated before (.ppk extension) and type in the pass phrase when prompted.

Note you will need to start pageant for every cvs session, so you may want to put it in your startup folder. However you will still have to load the key and type in the pass phrase when prompted each time.

4. Set up Putty

Start putty.exe. Specify hostname connection i.e. "cvs.w3.org". Then select the SSH protocol by clicking the appropriate radio button. Look down the menu to the left for the following:

On the SSH panel, check that the SSH2 radio button is selected.

Under Rlogin type in your CVS login name.

Enter the name "cvs.w3.org" (again) in the saved sessions text box and press the save button.

Click "Open" to connect to cvs.w3.org, and say yes if presented with a dialog box. If you don't do this your first attempt to connect via CVS will fail with a long slew of error messages that essentially mean that the authentication failed. You should only ever need to do this once. You can then close the command window that opened.

5. Testing connectivity

You can also do a handshake with the cvs server at w3c in the following way. This is useful for debugging.

a: get a command prompt
b: try plink.exe -v cvs.w3.org
It should go something like (not the user input of
user name).

C:\>plink -v cvs.w3.org
Server version: SSH-1.5-OpenSSH_3.4p1
We claim version: SSH-1.5-PuTTY
Using SSH protocol version 1
Received public keys
Host key fingerprint is:
      1024 06:ae:2a:63:45:30:41:81:ac:0a:5e:8f:0f:f2:d1:44
Encrypted session key
Using 3DES encryption
Trying to enable encryption...
Successfully started encryption
login as: <!!user input>jcarroll
Sent username "jcarroll"
Pageant is running. Requesting keys.
Pageant has 1 keys
Trying Pageant key #0
Remote: Pty allocation disabled.
Remote: Port forwarding disabled.
Remote: X11 forwarding disabled.
Remote: Agent forwarding disabled.
Received RSA challenge
Sending Pageant's response
Remote: RSA authentication accepted.
Pageant's response accepted
Authenticated using RSA key "rsa-key-20020424" from agent
Authentication successful
Server refused to allocate pty
Allocated pty
Started session
^C
C:\>

6. Setting up TortoiseCVS

On your hard drive, create a folder in which you will work with files from the server.

We'll follow an example here, to make things clearer. You will be given access only to a specific part of the directory hierarchy on the server. Let's suppose that you are being given access to the files below http://www.w3.org/International/docs/.

Right click on the folder you just created and select CVS Checkout from the context menu. This opens a dialogue box.

Under the Module tab in the dialogue box, set the following:

Server: cvs.w3.org
Repository folder:
/w3ccvs
Module: WWW/International/docs
Protocol: Secure shell (:ext:)
User name: <your-cvs-login-name>

Click OK. The contents of the charlint directory on the server are now copied to your computer.

7. Basic commands

You should look at the TortoiseCVS user guide, but here are the basics.

Before editing a file, you should always update you local copy. Right click on the file (or folder) and select CVS Update.

To commit a file after making changes, right click and select CVS Commit.

To move a new file to the server, first right click on it and select CVS Add. Then right click and select CVS Commit.

 

Hope that helps.

Version: $Id: editor-setup.html,v 1.2 2010/03/03 15:14:39 rishida Exp $