BOREALIS UTILITY SCRIPTS


1. CVS Scripts

The CVS scripts can be used to checkout Borealis or Nmstl and check in changes. The scripts are simple to use and provide error checking you might not perform when using raw CVS commands. You can also use raw CVS commands along with the scripts without conflict.


A. Setup Cvs Scripts on Unix

Manually check out Borealis and copy of the scripts to an installation directory. The Unix scripts are in: borealis/utility/unix/

At Brown the latest scripts are already installed for you in: //cs/dfs/pro/borealis/utility/unix/

You may want to change some of the default paths encoded in the scripts. The locations are preconfigured for installations at Brown. Files containing site specific paths are:


You can also override default settings by setting environment variables in your login script.


Run the cvs.borealis.csh or cvs.borealis.sh script from your login script to declare CVSROOT for the Borealis project and aliases to run the utility scripts. CVS_RSH will also be set to "ssh". This tells CVS that the remote shell is ssh.


The CVS repository for Borealis is at Brow. Developers at other sites need to enter their password for every CVS command. You can avoid re-entering your password by using cvs-agent.


B. Using the CVS Scripts

Get a working copy of the Borealis source code. The code will be put in the ${CVS_SANDBOX}/borealis/ directory. Any prior copy will be removed.


Make your changes, test them, and check them in.

The checkin utility (checkin.change.sh) performs collision and sanity checks for you. If recent changes have been committed that are newer than the copies in your sandbox then no files will be commited to the repository. You'll be prompted before adding any new files to the repository.


C. Some Useful CVS Commands

Here are some extra CVS commands you might find handy.


2. BOREALIS BUILD SCRIPT

The Borealis Build script compiles Borealis and optionally compiles Nmstl, the Borealis tools, the test area or demos. It is a self-contained file and can be used independently from the Borealis CVS scripts.


A. Setup the Build Script

The Borealis Build script needs to know the installation directories for several required packages. The default locations are set up for the installation at Brown. You can override the defaults with command arguments or by setting the following variables to the installation directory paths. The build script source file (build.borealis.sh) contains detailed documentation to setup and run the build script.

To exclude MySql and Berkeley-Db components from the build, do not define the INSTALL_MYSQL and INSTALL_BDB variables respectively.


The CVS_SANDBOX variable can be used to specify where you have checked out the source code. By default CVS_SANDBOX is set to the value of the HOME variable.


B. Building Borealis

To build Borealis you must first check out Borealis. If Nmstl is not installed and you are building it as well, check out Nsmtl, too.

You can suppress compilation and only run the configure step to regenerate the Makefiles by using the -configure option.

You can optionally build user defined boxes with the -udb option.

Before you checkin any changes you can verify they work in several build configurations with the validate.build.sh script. Before running this script Borealis and Nmstl must be checked out in your sandbox. You may also want to set the environment variables as described in the build.borealis.sh script. If not set they will be assigned default values.

Developer Links