Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Scripted Compilation on Linux Debian/Ubuntu

From FlightGear wiki
Revision as of 10:26, 28 July 2011 by Mmuc (Talk | contribs) (spelling and wording improvements)

Jump to: navigation, search

Description

The following script takes care of downloading and compiling FlightGear from the git repositories with just one command execution for both 32-bit and 64-bit Debian based systems (Debian, Ubuntu). Pre-existing installed version (if any) of FlightGear are not touched at all since the script builds and installs everything under the directory in which it is launched.

Necessary packages are installed via the apt-get system while libraries not included in the repositories are downloaded and compiled on the fly (i.e. Plib, Simgear and OSG).

List of compiled programs

The script is able to download and compile:

Download

You can download the script here: download_and_compile.sh

The script is maintained in the FlightGear main repository. Remember to update this script whenever a new FlightGear version is released, so that you'll be able to download the latest stable revision.

There is also another option for building FlightGear and all its dependencies in an automated fashion, please refer to: http://geoffmclane.com/fg/fgfs-052.htm

Instructions

To run download_and_compile.sh, just save it in a directory called for example: ~/fgfs then execute it (no need to execute it as root).

Here is for example a sequence of commands to get the script and launch it in a new folder.

mkdir ~/fgfs
cd ~/fgfs
wget http://www.gitorious.org/fg/fgmeta/blobs/raw/master/download_and_compile.sh
chmod 755 download_and_compile.sh
sh download_and_compile.sh

Once the script is finished, you will successfully get all the programs installed in the ~/fgfs directory.

Launching FlightGear

To run your new git installation of FlightGear you have to launch the run_fgfs.sh command under the same folder, for example:

cd ~/fgfs
sh run_fgfs.sh

Launching Fgrun

For many users it's more comfortable having FlightGear launched by the graphical utility Fgrun which is installed as well in the same folder. You have to launch the run_fgrun.sh command, for example:

cd ~/fgfs
sh run_fgrun.sh

Launching FGCOM

FGCOM is the system used by FlightGear to simulate radio communications between users. Launch it using the run_fgcom.sh command:

cd ~/fgfs
sh run_fgcom.sh -cs

Launching FGComGui

FgComGui is a GUI wrapper to launch fgcom.

cd ~/fgfs  
sh run_fgcomgui.sh

Launching Atlas

Atlas provides a map for FlightGear, use it launching: run_atlas.sh

cd ~/fgfs
sh run_fgatlas.sh

Launching Terrasync

Your FlightGear compilation comes with the Terrasync program too, so if you want to use it:

cd ~/fgfs
sh run_terrasync.sh -S -p 5500 -d /folder/with/sceneries

Where: /folder/with/sceneries is the folder containing the sceneries data.

Then launch fgfs with the --fg-scenery=/folder/with/sceneries --atlas=socket,out,5,localhost,5500,udp option

Troubleshooting

Compilation errors

Here we are, no fear, if you wish to use programs from the cvs/svn/git repositories, you might face compilation errors that will prevent you to have a working copy of one or more of the programs provided by this script. What can be the causes that prevent us from successfully compiling? As far as I know those:

  1. Software developers introduce a new functionality with a new piece of code that prevents the compilation under your architecture, this can happen working with cvs/svn/git sources.
  2. The program refuses to compile because of a divergence in the libraries on which it depends. For example FlightGear might not compile because OSG has been modified, while OSG itself compiles fine, FG won't.
  3. One or more repositories are down and you can't get the library you need. (Both from cvs/svn/git or apt-get)

There is a simple solution to the above errors: wait and relaunch the script after some time (hours or days), if software developers repair or synchronize their code with the newly updated libraries (which generally happens eventually), your FlightGear will compile fine as if the previous error never took place.

Sometimes it happens that the script fails to compile only fgrun, fgcom or atlas, if you then see the run_fgfs.sh file it means that FlightGear installation was successful and you can safely run it.

Options

The script by default (without any option) will only compile FlightGear and Fgrun. To make it compile all, you need to launch the script with the ALL parameter. i.e.:

sh download_and_compile.sh ALL

Compiling only one program

If you wish to recompile only one of the programs you can launch the script with one of the following parameters:

  • PLIB (to compile and install only plib)
  • OSG (to compile and install only OpenSceneGraph)
  • SIMGEAR (to compile and install only Simgear)
  • FGFS (to compile and install only FlightGear)
  • DATA (to download / update only data files for FlightGear)
  • FGRUN (to compile and install only Fgrun)
  • FGCOM (to compile and install only Fgcom)
  • FGCOMGUI (to compile and install only FgComGui)
  • ATLAS (to compile and install only Atlas)

Fast updating

There is a second parameter UPDATE that allows you to just update your installation. i.e.: This will only update FGFS

sh download_and_compile.sh FGFS UPDATE

Compiling last stable versions (Experimental)

Event if the script fetches data and sources from bleeding edge developers repositories (which sometimes do not compile), you can still force the script to download latest known versions of the software that were compiling successfully by adding the -s option.

sh download_and_compile.sh -s

How does it work? Inside the script there is a small list with latest known versions of successfully compiling revisions, it will download from svn/git those specific revisions, which have been found able to compile together.

Advanced options

  • Skip download of packages using -p n option
  • Skip compilation of programs using -c n option
  • Skip retrieving software updates using -d n option
  • Skip reconfigure (make clean) using -r n option

For example, if you are a developer and wish to quickly recompile and reinstall only your own modifications for FlightGear do this:

sh download_and_compile.sh -p n -d n -r n  FGFS

this will only recompile modifications and reinstall them.

Multicore Acceleration

Using the option -j x (where x is the number of your CPU-Cores you wish to assign to the job) will speed up the whole compilation process considerably.

Disk usage

Having both compiled program, source code, and data from git requires some hard disk space: It will take something like 7 GB of space. If you don't have a fast machine, it will require you also several hours of compilation time.