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