# How to start

## Setting up the development environment

1. Install the most recent FPC release for your operating system, get it here
2. Get the latest FPC source via subversion, read here how to do so.
• Change to the directory fpc
• type make all and test see if it works without problems. If you've problems with the build, or for a general background info for the process, be sure to check the buildfaq.
• If you wish to do so, you can install the newly generated compiler with make install (This may need sudo).

Now you're ready to modify the compiler.

## Directory layout of the compiler

The compiler sources are located in fpc/compiler and its subdirectories.

• fpc/ the main directory
• compiler/ files common for all target processors.
• The processor specific files are in subdirectories alpha, arm, powerpc, i386 (i386 only), ia64, m68k, mips, powerpc, powerpc64, sparc, x86 (x86 general) and x86-64 (x86-64 only).
• systems/ information files for the supported operating systems.
The i_*.pas files contain the information that is necessary for either hosting or building a compiler compiling for this target.
The t_*.pas files contain the code which is necessary if a compiler is built for compiling for this particular target.
• msg/ compiler messages in various languages.
• utils/ mainly help programs for compiler development. The are usually not important at the beginning.

## Building the compiler

To build the compiler only, a make in fpc/compiler is enough. However, if you want to test the generated compiler and you aren't building a cross compiler, better do a make cycle. This tests if the modified compiler can compile itself and the rtl.

### Building a cross compiler

Building a cross compiler for another processor target is simple as well, just do a make CPU_TARGET=<processor target>.

Available processor targets for the current vresion are: arm, ia64, i386, powerpc, ppc64, sparc and x86_64. However, some of them might not work at the moment.

## Testing changes

When doing changes, it is always good to test these changes, for example by running the testsuite.

### Running the testsuite

The readme file in the fpc/tests directory contains more complete test suite instructions.

 cd fpc
make clean all
cd tests
make clean all digest


You'll get something like this at the end:

 ...
/FPC/home/fpc/bin/digest output/i386-linux/log
Total = 2975 (28:2947)
Total number of compilations = 1692 (12:1680)
Successfully compiled = 1361
Successfully failed = 319
Compilation failures = 12
Compilation that did not fail while they should = 0
Total number of runs = 1283 (16:1267)
Successful runs = 1267
Failed runs = 16
...


The important line is

 Total = 2975 (28:2947)


It shows how much tests were run: 2975, how much failed: 28 and now much succeded: 2947. If you want to know what failed, see fpc/tests/output/<target>/longlog and fpc/tests/output/<target>/log.