ReadMe.Compiling.md

   1 Building Haiku
   2 ==========================
   3 This is a overview into the process of building HAIKU from source.
   4 An online version is available at <https://www.haiku-os.org/guides/building/>.
   5
   6 Official releases of Haiku are at <https://www.haiku-os.org/get-haiku>.
   7 The (unstable) nightly builds are available at <https://download.haiku-os.org/>.
   8
   9 We currently support the following platforms:
  10  * Haiku
  11  * Linux
  12  * FreeBSD
  13  * macOS
  14
  15 Required Software
  16 ----------------------------
  17 Tools provided within Haiku's repositories:
  18  * `jam` (Jam 2.5-haiku-20111222)
  19  * Haiku's cross-compiler (needed only for non-Haiku platforms)
  20
  21 The tools to compile Haiku will vary, depending on the platform that you are
  22 using to build Haiku. When building from Haiku, all of the necessary
  23 development tools are included in official releases (e.g. R1/alpha4) and in the
  24 nightly builds.
  25
  26  * `git`
  27  * `gcc`/`g++` and binutils (`as`, `ld`, etc., required by GCC)
  28  * (GNU) `make`
  29  * `bison` (2.4 or better)
  30  * `flex` and `lex` (usually a mini shell script invoking `flex`)
  31  * `makeinfo` (part of `texinfo`, only needed for building GCC 4)
  32  * `autoheader` (part of `autoconf`, needed for building GCC)
  33  * `automake` (needed for building GCC)
  34  * `gawk`
  35  * `nasm`
  36  * `wget`
  37  * `[un]zip`
  38  * `cdrtools` (preferred) or `genisoimage`
  39  * case-sensitive file system
  40
  41 Whether they are installed can be tested by running them in a shell with
  42 the `--version` parameter.
  43
  44 The following libraries (and their respective headers) are required:
  45  * `curl`
  46  * `zlib`
  47
  48 ### Haiku for ARM
  49 If you want to compile Haiku for ARM, you will also need:
  50
  51  * `mkimage` (<http://www.denx.de/wiki/U-Boot/WebHome>)
  52  * Mtools (<https://gnu.org/software/mtools/intro.html>)
  53
  54 ### On macOS
  55
  56 Disk Utility can create a case-sensitive disk image of at least 3 GiB in size.
  57 The following ports need to be installed:
  58  * `expat`
  59  * `gawk`
  60  * `gettext`
  61  * `libiconv`
  62  * `gnuregex`
  63  * `gsed`
  64  * `cdrtools`
  65  * `nasm`
  66  * `wget`
  67  * `less`
  68  * `mpfr`
  69  * `gmp`
  70  * `libmpc`
  71  * `bison` (updated to the latest version)
  72
  73 More information about individual distributions of Linux and BSD can be found
  74 at <https://haiku-os.org/guides/building/pre-reqs>.
  75
  76 Downloading Haiku's sources
  77 --------------------------------------------------
  78 There are two parts to Haiku's sources &mdash; the code for Haiku itself and a set
  79 of build tools for compiling Haiku on an operating system other than Haiku.
  80 The buildtools are needed only for non-Haiku platforms.
  81
  82 Anonymous checkout:
  83 ```
  84 git clone https://git.haiku-os.org/haiku
  85 git clone https://git.haiku-os.org/buildtools
  86 ```
  87 (You can also use the `git://` protocol, but it is not secure).
  88
  89 If you have commit access:
  90 ```
  91 git clone ssh://git.haiku-os.org/haiku
  92 git clone ssh://git.haiku-os.org/buildtools
  93 ```
  94
  95 Building Jam
  96 -------------------------------------------
  97 (*This step applies only to non-Haiku platforms.*)
  98
  99 Change to the `buildtools` folder and run the following commands to
 100 generate and install `jam`:
 101 ```
 102 cd buildtools/jam
 103 make
 104 sudo ./jam0 install
 105 ```
 106 Or,  if you don't want to install `jam` systemwide:
 107 ```
 108 ./jam0 -sBINDIR=$HOME/bin install
 109 ```
 110
 111 Configuring the build
 112 -------------------------------------
 113 The `configure` script generates a file named `BuildConfig` in the
 114 `generated/build` directory. As long as `configure` is not modified (!) and the
 115 cross-compilation tools have not been updated, there is no need to call it again.
 116 For rebuilding, you only need to invoke `jam` (see below). If you don't
 117 update the source tree very frequently, you may want to execute `configure`
 118 after each update just to be on the safe side.
 119
 120 Depending on your goal, there are several different ways to configure Haiku.
 121 The first way is to call configure from within your Haiku checkout's root. That
 122 will prepare a folder named 'generated', which will contain the compiled objects.
 123 Another option is to manually created one or more `generated.*` folders and run
 124 configure from within them. For example, imagine the following directory setup:
 125 ```
 126 buildtools/
 127 haiku/
 128 haiku/generated.x86gcc2
 129 ```
 130
 131 ### Configure a GCC 2.95/GCC 5 Hybrid, from a non-Haiku platform
 132 ```bash
 133 cd haiku/generated.x86gcc2
 134 ../configure \
 135         --build-cross-tools x86_gcc2 ../../buildtools/ \
 136         --build-cross-tools x86
 137 ```
 138
 139 ### Configure an x86_64 (GCC 5) build, from a non-Haiku platform
 140 ```
 141 cd haiku/generated.x86_64
 142 ../configure --build-cross-tools x86_64 ../../buildtools/
 143 ```
 144
 145 ### Configure a GCC 2.95/GCC 5 Hybrid, from Haiku
 146 ```
 147 cd haiku/generated.x86gcc2
 148 ../configure --target-arch x86_gcc2 --target-arch x86
 149 ```
 150
 151 Additional information about GCC Hybrids can be found on the website,
 152 <https://www.haiku-os.org/guides/building/gcc-hybrid>.
 153
 154 ### Configure options
 155 The various runtime options for configure are documented in its onscreen help
 156 ```bash
 157 ./configure --help
 158 ```
 159
 160 Building via Jam
 161 ----------------------------
 162
 163 Haiku can be built in either of two ways, as disk image file (e.g. for use
 164 with emulators, to be written directly to a usb stick, burned as a compact
 165 disc) or as installation in a directory.
 166
 167 ### Running Jam
 168
 169 There are various ways in which you can run `jam`:
 170
 171  * If you have a single generated folder, you can run 'jam' from the top level of Haiku's trunk.
 172  * If you have one or more generated folders, (e.g. generated.x86gcc2),
 173    you can `cd` into that directory and run `jam`.
 174  * In either case, you can `cd` into a certain folder in the source tree (e.g.
 175    src/apps/debugger) and run jam -sHAIKU_OUTPUT_DIR=<path to generated folder>
 176
 177 Be sure to read `build/jam/UserBuildConfig.ReadMe` and `UserBuildConfig.sample`,
 178 as they contain information on customizing your build of Haiku.
 179
 180 ### Building a Haiku anyboot file
 181 ```
 182 jam -q @anyboot-image
 183 ```
 184
 185 This generates an image file named `haiku-anyboot.image` in your output
 186 directory under `generated/`.
 187
 188 ### Building a VMware image file
 189 ```
 190 jam -q @vmware-image
 191 ```
 192 This generates an image file named `haiku.vmdk` in your output
 193 directory under `generated/`.
 194
 195 ### Directory Installation
 196 ```
 197 HAIKU_INSTALL_DIR=/Haiku jam -q @install
 198 ```
 199
 200 Installs all Haiku components into the volume mounted at "/Haiku" and
 201 automatically marks it as bootable. To create a partition in the first place
 202 use DriveSetup and initialize it to BFS.
 203
 204 Note that installing Haiku in a directory only works as expected under Haiku,
 205 but it is not yet supported under Linux and other non-Haiku platforms.
 206
 207 ### Building individual components
 208 If you don't want to build the complete Haiku, but only a certain
 209 app/driver/etc. you can specify it as argument to jam, e.g.:
 210 ```
 211 jam -q Debugger
 212 ```
 213 Alternatively, you can `cd` to the directory of the component you want to
 214 build and run `jam` from there. **NOTE:** if your generated directory is named
 215 something other than `generated/`, you will need to tell `jam` where it is:
 216 ```
 217 jam -q -sHAIKU_OUTPUT_DIR=<path to generated folder>
 218 ```
 219 You can also force the rebuild of a component by using the `-a` parameter:
 220 ```
 221 jam -qa Debugger
 222 ```
 223
 224 Running
 225 ----------------
 226 Generally there are two ways of running Haiku: on real hardware using a
 227 partition, and on emulated hardware using an emulator (like VirtualBox, or QEMU).
 228
 229 ### On Real Hardware
 230 If you have installed Haiku to its own partition you can include this
 231 partition in your bootmanager and try to boot Haiku like any other OS you
 232 have installed. To include a new partition in the Haiku bootmanager, start
 233 the BootManager configurator by running:
 234 ```
 235 BootManager
 236 ```
 237
 238 ### On Emulated Hardware
 239 For emulated hardware you should build a disk image (see above). How to set up
 240 this image depends on your emulator. If you use QEMU, you can usually just
 241 provide the path to the image as command line argument to the `qemu`
 242 executable.