docs/how-to-build.md

   1 How to build unleashed
   2 ======================
   3
   4 Install unleashed
   5 -----------------
   6
   7 Building unleashed requires unleashed, so first you must install it (doing
   8 which is not documented at the time of writing).
   9
  10 Get the source
  11 --------------
  12
  13 Clone this repository from either:
  14
  15 * git://repo.or.cz/unleashed.git
  16 * http://repo.or.cz/unleashed.git
  17
  18 For example:
  19
  20 ```
  21 $ git clone git://repo.or.cz/unleashed.git
  22 $ cd unleashed
  23 ```
  24
  25 Build
  26 -----
  27
  28 For a complete build, use 'tools/nightly.sh':
  29
  30 ```
  31 $ ./tools/nightly.sh
  32 ```
  33
  34 On success, this results in installable packages in the `packages` directory.
  35
  36 Incremental build
  37 -----------------
  38
  39 To build a component that is using the new build system (e.g., cat(1)), change
  40 into the source directory and run make. For example:
  41
  42 ```
  43 $ cd bin/cat
  44 $ make
  45 # make install
  46 ```
  47
  48 The component will be built against the running system and installed to /. To
  49 install to the proto area, pass DESTDIR=path to 'make install'. Building
  50 against libraries and headers in the "proto area" or in object directories is
  51 not currently supported.
  52
  53 To build a component under the legacy (dmake) build system, ie. things under
  54 'usr/src', first complete a full nightly build so that prerequisite objects for
  55 the component are made, and then:
  56
  57 ```
  58 $ ./tools/bldenv.sh <env file>
  59 $ cd usr/src/cmd/w
  60 $ dmake install
  61 ```
  62
  63 The component will be built against the "proto area" and installed there.