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 `tools/nightly.sh` directly
  15     - many of the nightly options were removed
  16   - support for multi-proto and multiple builds was removed
  17 * `bldenv` is not shipped, just use `tools/bldenv.sh` directly
  18
  19 ### illumos-gate to unleashed directory mapping
  20
  21 The source tree layout is different.  It attempts to be wider (rather than
  22 deep) and better subdivided.  It is loosly based on the Linux kernel and
  23 BSD repositories.  The description of the repository layout can be found in
  24 `docs/repo-layout.md`.
  25
  26 The following are *rough* mappings between the two repositories to give you
  27 a vague idea where files ended up.
  28
  29 * `usr/src/cmd` -> `bin`
  30 * `usr/src/lib` -> `lib`
  31 * `usr/src/head` -> `include`
  32 * `usr/src/uts/common/os` -> `kernel/os`
  33 * `usr/src/uts/common/vm` -> `kernel/vm`
  34 * `usr/src/uts/common/sys` -> `include/sys`
  35 * `usr/src/uts/intel` -> `arch/x86`
  36
  37 Contribution Process
  38 --------------------
  39
  40 It's pretty simple:
  41
  42 1. make a patch
  43 2. send the patch to the mailing list for review (there's no webrev, just
  44    send a diff) and apply any feedback you get
  45 3. one of the committers will take your patch and commit it for you
  46
  47 Note, there is no special illumos like RTI step.
  48
  49 See Also
  50 --------
  51
  52 * The Code of Conduct (docs/code-of-conduct.md)
  53 * Community Organization (docs/organization.md)
  54 * Repository Layout (docs/repo-layout.md)