docs/illumos-refugees.md

   1 Guide for illumos-gate Refugees
   2 ===============================
   3
   4 This guide is meant for those that are familiar with the illumos process and
   5 repository.  If you are not familiar with illumos and illumos-gate, your
   6 time will likely be better spent looking at the top-level README as this
   7 guide only highlights the differences between the two communities.
   8
   9 Repository
  10 ----------
  11
  12 * Building with Sun Studio and lint is *not* supported
  13 * `nightly`
  14   - `nightly` is not shipped, just use `usr/src/tools/scripts/nightly.sh`
  15     directly
  16     - many of the nightly options were removed
  17   - support for multi-proto and multiple builds was removed
  18 * `bldenv` is not shipped, just use `usr/src/tools/scripts/bldenv.sh`
  19   directly
  20
  21 ### illumos-gate to unleashed directory mapping
  22
  23 The source tree layout is different.  It attempts to be wider (rather than
  24 deep) and better subdivided.  It is loosly based on the Linux kernel and
  25 BSD repositories.  The description of the repository layout can be found in
  26 `docs/repo-layout.md`.
  27
  28 The following are *rough* mappings between the two repositories to give you
  29 a vague idea where files ended up.
  30
  31 * `usr/src/cmd` -> `bin`
  32 * `usr/src/lib` -> `lib`
  33 * `usr/src/head` -> `include`
  34 * `usr/src/uts/common/os` -> `kernel/os`
  35 * `usr/src/uts/common/vm` -> `kernel/vm`
  36 * `usr/src/uts/common/sys` -> `include/sys`
  37 * `usr/src/uts/intel` -> `arch/x86`
  38
  39 Contribution Process
  40 --------------------
  41
  42 TODO
  43
  44 See Also
  45 --------
  46
  47 * The Code of Conduct (docs/code-of-conduct.md)
  48 * Community Organization (docs/organization.md)
  49 * Repository Layout (docs/repo-layout.md)