Source Code Control (Komodo Pro) |
Using SCC
Check out the Komodo Tour |
Komodo's source code control integration works in conjunction with
CVS and
Perforce. From within
Komodo, you can perform most common SCC actions, such as:
- checking files out of the source code repository
- comparing files in the editor against their repository versions ("diff")
- submitting files back to the repository
Source code control functions are accessible from the
following locations:
- Toolbox context menu: right-click a file in the
Toolbox to access the
Source Control menu options. Source code control functions
can also be performed on Folders in the Toolbox; right-click a folder and
select Source Control on Contents to access the menu.
- Project Manager context menu: right-click a file in the
Project
Manager to access the Source Control menu options.
Source code control functions can also be performed on Folders in the Toolbox;
right-click a folder and select Source Control on Contents to
access the menu.
Note: When you right-click a project or folder in either the
Project Manager or the Toolbox, two source code control items will be available
from the context menu. Source Control applies source code functions
to the selected file only. Source Control on Contents applies source code functions
to the contents of the selected project or folder.
- Editor Pane: right-click a file in the Editor Pane to
access the Source Control menu options.
- File Name tab: right-click the file name tab above the
Editor Pane to access the Source Control menu options.
- File menu: select the Source Control
option from the File menu.
The Source Control menu options are the same regardless
of which method is used to access the menu.
To view the location of the CVS executable files found on your system and to determine
which executable is used, select Edit|Preferences|Source Code Control|CVS.
If CVS is not properly configured, or if the CVS executable file you have is
incompatible with Komodo, the CVS Source Code Control page in Preferences will display
a message advising that CVS integration has been disabled. To begin configuring CVS,
click Download CVS and follow the instructions on the ASPN Web site.
On Windows, you can determine the version of cvs.exe installed on your system
by entering cvs -v at a command prompt. If this returns
Concurrent Versions System (CVSNT) rather than
Concurrent Versions System (CVS) , your CVS version is not
compatible with Komodo. Linux uses the standard version of CVS.
The CVS executable must be located in a directory specified in your
system's PATH environment variable.
On Windows 98 and Me, you must configure a HOME environment
variable, for example "HOME=c:\ ". Reboot before proceeding.
Putty is a free SSH, Telnet and Rlogin client for 32-bit Windows systems.
Note: You only need to install Putty if you are using CVS
with SSH.
1. Install Putty
Komodo requires Putty version 0.52 or greater. Putty and the associated
programs can be downloaded from:
http://www.chiark.greenend.org.uk/~sgtatham/putty/
You will require the following Putty programs:
putty.exe
puttygen.exe
pageant.exe
pscp.exe
plink.exe
Ensure that the directory where Putty is installed is specified in your
system's PATH environment variable.
2. Generate the Putty Key
Run the puttygen utility. Configure as follows:
- Parameters: select "SSH2 RSA" or "SSH2 DSA" (it
doesn't matter which).
- Generate: click the Generate button to
generate the key pair. While the key is being generated, move the mouse
around the blank space to provide key randomness.
- Key Passphrase: enter and confirm a passphrase for the
key. Remember the passphrase - it will be required later.
- Save Public Key: click the "Save public key" button
and store the key in a file called
public1.key .
- Save Private Key: click the "Save private key" button
and store the key in a file called
private1.key , in the
same directory where you saved the public key.
- Copy Key Contents: copy the contents of the public
key field (at the top of the dialog) to a file named
public1-openssh.key . This key will be required later.
- Close puttygen
3. Load and Configure the Putty Authentication Agent
Run the pageant program. This will load the Putty Authentication
Agent into the Windows System Tray.
Right-click the Pageant icon in the Windows System Tray. Select
Add Key. Navigate to the directory where you saved the public
and private keys in the previous step, and select the file
private1.key .
4. Configure Putty to use Pageant
Run the putty program. Configure as follows:
- Specify the CVS Server: on the Session
page of the Configuration form, enter the host name or IP address of the
CVS server.
- Specify Protocol: on the Session page,
in the Protocol field, select the "SSH" protocol.
- Create Saved Session: in the Saved Sessions
field, enter the host name again. Click the Save button.
- Configure Connection: on the Connection
page of the Configuration form, enter your user name for the CVS server
in the field labeled Auto-login username.
- Configure SSH Protocol: on the SSH
page of the Configuration form, specify "2" for the Preferred
SSH protocol version.
- Enable Agent Forwarding: on the Auth
page of the Configuration form, check Allow agent forwarding.
In the Private key file for authentication field, specify
the path and file name of the private key created above
(
private1.key ).
- Save Session Information: on the Session
page of the Configuration form, click the Save button.
5. Store Public Key on CVS Server
You must store the public key file generated in step 2
(public1-openssh.key ) on the CVS server.
- Open Command Window: open a command prompt window by
typing
cmd in the Windows Run dialog.
- Copy Public Key to Server: at the command prompt, enter:
pscp c:\path\to\public1-openssh.key username@cvs.server.com:public1-openssh.key
...where c:\path\to\public1-openssh.key specifies the location of the key
file created in step two, and username@cvs.server.com specifies your user name
on the CVS server and the URL of the CVS server. You will be prompted to confirm
the legitimacy of the host, and you may be prompted to enter your password
for the CVS server.
- Connect using Putty: if necessary, run the
putty program. In the Saved Sessions field,
double-click the configuration created in Step 4. This will establish a
connection to the CVS server.
- Configure the Key on the Server: after logging into the
CVS server, enter the following commands to configure the SSH key:
mkdir ~/.ssh
chmod 700 .ssh
cat ~/public1-openssh.key >> ~/.ssh/authorized_keys
rm ~/public1-openssh.key
chmod 600 ~/.ssh/*
- Log off and Exit Putty: enter
exit to close
the session of the server.
6. Test the Configuration
Restart Putty. In the Saved Sessions field,
double-click the configuration created in Step 4. You should not be prompted
to log in. If you are, the configuration failed. Review the steps above and
ensure that they were completed correctly.
7. Check Out a CVS Module
- Create Local CVS Directory: create a directory on your
system to store a copy of the CVS repository.
- Copy Files to Local Directory: at a command prompt, enter:
set CVS_RSH=plink
set PLINK_PROTOCOL=ssh
cvs -d :ext:username@cvs.server.com:/repository_name co cvs_module
...where username@cvs.server.com specifies your user name
on the CVS server and the URL of the CVS server, repository_name
specifies the name of the repository on the server, and cvs_module
specifies the name of the module in the repository that you want to work with.
Login will be handled by SSH. The files will be copied down to your
local system. These environment variables will not interfere with non-SSH
repositories.
These variables should be permanently configured in your system environment
(for example, by adding them to the autoexec.bat
file or configuring them in you system properties. Windows Me and 9x systems
must be rebooted after adding environment variables.
8. Using Komodo and CVS
Before starting Komodo, perform the following steps:
If you are running Windows 9x or Windows Me, you must permanently configure these
variables in the environment (for example, by adding them to the autoexec.bat
file), and then you must reboot before proceeding.
Secure Shell (SSH) is a program used to access another computer over a network in
order to execute commands and manage files remotely. You
must install Putty
for SSH to work with CVS.
To configure CVS to use SSH, refer to
http://xml.apache.org/forrest/community/howto/cvs-ssh/howto-cvs-ssh.html.
Be sure to read the instructions carefully!
On all platforms, create an environment variable as follows:
CVS_RSH=ssh
CVS will be able to determine when to use SSH depending
on how you check out the modules. If you use the 'cvs login' method
with the 'pserver' protocol, CVS will not use SSH even if
CVS_RSH=ssh is set in the environment.
On Windows, you must also configure the cygwin SSH Agent as follows:
- Open a cygwin shell.
- Enter
exec ssh-agent bash .
- Enter
ssh-add .
- To check out a CVS module, enter:
cvs -d :ext:username@cvs.server.com:/repository_name co cvs_module
...where username@cvs.server.com specifies your user name
on the CVS server and the URL of the CVS server, repository_name
specifies the name of the repository on the server, and cvs_module
specifies the name of the module in the repository that you want to work with.
- Start Komodo within the cygwin shell as follows:
/path/to/komodo/komodo.exe
After you have completed the above configuration steps, follow these steps
to open Komodo with CVS-SSH enabled:
- Open a cygwin shell.
- Enter
exec ssh-agent bash .
- Start Komodo within the cygwin shell as follows:
/path/to/komodo/komodo.exe
Ensure that the command-line version of Perforce ("P4") is correctly installed
and functional before working with a Perforce repository within Komodo. The
p4.exe file must be located in a directory that is specified
in your PATH environment variable.
Perforce users who use the P4CONFIG feature of perforce may find that
Komodo's source code control doesn't work unless Komodo is started from
within the client view of the Perforce repository they are working in.
Use the Source Code Control page in Komodo's
Preferences to configure
Source Code Control integration. To open the Komodo Preferences, select
Edit|Preferences.
Top
Source Code Control Toolbar
Common source code control commands can be accessed from the
Toolbar
at the top of the Komodo workspace. Refer to the command descriptions below
for more information. The toolbar commands apply to the file that is currently
displayed in the Editor Pane.
Source Code Control Menus
Source code control functions can be accessed by selecting
File|Source Control
Source code control context menus can be invoked by right-clicking on files
or folders in the following areas:
The SCC Output tab is located in the Output Pane in
the Komodo workspace. As you execute source code control commands, such as
editing or checking in files, details of the command will be displayed on the
SCC Output tab.
Error messages and warnings are also displayed on the
SCC Output tab. Additionally, error messages and warnings
are displayed on the status bar in the bottom left corner of the Komodo
workspace.
As described above, source code control commands can be invoked from
the toolbar, the File menu and the Source Control context menu. The following
commands will be available, depending on the context:
- Add: Adds a file from a designated source code directory
on your local drive to the source code repository.
- Edit: Checks out a file from the current source code
repository.
- Revert Changes: Checks the file back into the
repository, abandoning any changes made since it was checked out.
- Remove: Deletes the file from both the source code
repository and the corresponding local directory.
- Update: When the local version no longer matches the
repository version of a file, select this command to bring the local version
of the file up to date.
- Diff (Compare Files): Compares the version of a file open
in the Editor Pane with the version in the source code repository. Depending on
the setting in Preferences,
the diff display will be shown on another Komodo editor tab, in a separate window,
or with an alternate diff tool. The style of diff can be configured
in Preferences. The location of an alternate diff tool must also be specified in
the system's PATH environment variable.
- Commit Changes: submits the file back to the source
code repository.
Under Perforce, if you want to open files for edit from within a Komodo project,
you must first add files to the project using options on the Project menu. To
accomplish the same under CVS, use the following procedure:
- At the command prompt, enter
cvs co <projname> to open
working copies of the files.
- On the Projects tab, right-click the project and select
Import from File System.
- In the Import from File System dialog box, specify the location
of the files to be imported and click Next.
- Click OK to confirm changes to the project.
Top
If Perforce or CVS is enabled in Komodo's
Preferences, the status of
files in the source code repository is indicated by icons that appear on file
tabs in the Editor Pane and next to files and projects on the Projects tab.
The icons can appear in a variety of combinations, depending on the status of
the file and where they are displayed in the Komodo workspace. For example, a green
circle next to a padlock on a tab in the Editor Pane indicates that the file is
open for edit and that the version of the file in your local directory is in sync
with the version in the source code repository.
 |
The file is being added to the source code repository. |
 |
The file is being deleted from the source code repository. |
 |
The file is open for edit. |
 |
The version of the file in your local directory is in sync with
the version in the source code repository. |
 |
The file is read-only. |
 |
The version of the file in your local directory is out of sync with
the version in the source code repository. |
 |
There is a conflict between the version of the file in your local
directory and the source file that cannot be resolved by simply syncing your
directory with the source code repository. The discrepancy must be manually
resolved. |
Top
|