[Delta] Building the Helix client libraries

[Justin Karneges]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Here are some instructions for buildling the client libraries on Linux.  This 
is enough if you want to try my Qt-based test program.

First, here is the official documentation:
  https://common.helixcommunity.org/2004/devdocs/quickstart

I'll briefly go over some points from it.

First, you need to create a helix community account (to get access to 
anything) and agree to their EULA (to get access to the proprietary codecs).  
Steps 1 & 2 provide the details on this.

Next, be sure you have python, cvs, ssh, and xfree86 4 or higher.

Since their build tool invokes cvs+ssh on your behalf, you'll want to set up a 
rsa-key based login, or else you'll probably have to type your password a 
hundred times during the build process.  Parts 7 to 11 go over this.

In addition, ensure that your ~/.cvsrc (if you have such a thing), doesn't 
specify -P as a default option to checkout.  If you've ever done KDE CVS 
compilation, you might have this there and you'll need to take that line out.

Now to actually start downloading stuff!

First, set up cvs to use ssh, like this:

  export CVS_RSH=ssh

Next, make a fresh directory for which all of your helix work will take place, 
go into it, and grab the ribosome build system:

  cvs -d :ext:myusername at cvs.helixcommunity.org:/cvsroot/ribosome co build

(Of course, replace "myusername" with your actual account name.)

The next step is to set up your environment for easy future use.  I created a 
script called 'helixenv' to do this for me:

  export CVS_RSH=ssh
  export BUILD_ROOT=your_helix_folder/build
  export PATH=$BUILD_ROOT/bin:$PATH
  export SYSTEM_ID=linux-2.2-libc6-gcc32-i586

Note that this SYSTEM_ID is recommended for anyone using gcc 3.2+ on a Linux 
system, regardless of the kernel type (despite that it says 2.2, I'm not 
actually using kernel 2.2 :) ).

At this point, I'm moving beyond the general helix build setup and into the 
client-specific setup.  If you want to follow along, here are the official 
docs:
  https://helix-client.helixcommunity.org/2004/devdocs/quickstart

Create a ~/.buildrc file, with content like this:

  AddMultiCVS("helix",":ext:myusername at cvs.helixcommunity.org:/cvsroot/")
  AddBIFPath("common", "[helix]/common/build/BIF")
  AddBIFPath("client", "[helix]/client/build/BIF")

(And of course, replace "myusername" with your actual account name.)

Now you can actually build something.  Make a new sub directory in your helix 
work area called "splay".

  mkdir splay
  cd splay
  build

If running 'build' doesn't work, then you goofed up a step earlier (probably 
PATH).  After running this, you'll get a menu.  It should be simple to 
navigate.  Set the branch to "hxclient_1_3_0_neptunex", the target to 
"splay", the profile to "helix-client-all-defines", and enable release mode.  
The top part of your menu, therefore, should look like this:

  [0] Set BIF branch (hxclient_1_3_0_neptunex)
  [1] Set Target(s) (splay)
  [2] Set Profile(helix-client-all-defines)
  [3] run: build -trelease

Now start the build (command #3).  After lots of compiling, it will tell you 
if any modules failed.  Hopefully everything builds properly, and you get a 
message like this:

  "Build complete, 0 of 105 modules failed."

You can then choose 'Q' to leave the menu.  Congratulations, you're done!

- -Justin
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)

iD8DBQFBQNec8+Nd5hn1dJ4RAgCoAKCDK2WCu7906UTfbIr23AUyr8ExMQCgkk3q
sytSVjRfJR9tnQxVoJfa1sU=
=bZ3C
-----END PGP SIGNATURE-----