blob: a2759b6940c48ec11f663d20ca3309d1b8e5d1f7 [file] [log] [blame]
Garrett D'Amore2ad72052010-09-13 15:21:36 -07001illumos gate README - Sept 12, 2010.
Garrett D'Amore969bc942010-07-29 16:07:59 -07002
Garrett D'Amore2ad72052010-09-13 15:21:36 -07003This is the illumos gate. This is the illumos source tree. It contains
4the following subdirectories:
Garrett D'Amore969bc942010-07-29 16:07:59 -07005
Garrett D'Amore2ad72052010-09-13 15:21:36 -07006 usr/src - The actual source code
Garrett D'Amore969bc942010-07-29 16:07:59 -07007
Garrett D'Amore2ad72052010-09-13 15:21:36 -07008 exception_lists - These are lists of exceptional cases
9 used to limit noise during builds.
10 Ideally this directory would consist of
11 only empty files.
Garrett D'Amore969bc942010-07-29 16:07:59 -070012
13Integration Rules:
14
Garrett D'Amore2ad72052010-09-13 15:21:36 -070015 All changes must have been reviewed, and approved by and advocate
16 (below). A code review may be performed by someone other than the
17 advocate, but the final integration should still be approved by the
18 advocate.
19
20 The advocate will want to see your webrev and hg outgoing -v. The
21 advocate will also ask about your testing, and may ask to see your
22 build logs.
Garrett D'Amore969bc942010-07-29 16:07:59 -070023
24 All changes must adhere to typical ON style and quality rules.
25 For example, pass full cstyle, applicable lint rules, etc.
26
Garrett D'Amore2ad72052010-09-13 15:21:36 -070027 All commits must include either a CDDL license, unless
28 approved otherwise by the gatekeeper, or the modified code
29 already carries a different license. Exceptions shall require
30 the approval of the gatekeeper.
Garrett D'Amore969bc942010-07-29 16:07:59 -070031
32 Hg commits should have comments of the following form:
33
34 1234 This is a sample bug report synopsis
35 4567 If you have a second bug synopsis...
36 Reviewed by: codereviewer@somewhere.net
37 Approved by: gatekeeper@somewhere.else.com
38
Garrett D'Amore2ad72052010-09-13 15:21:36 -070039 Each commit must have at least one bug id that is listed in the
40 illumos-gate project at www.illumos.org.
41
Garrett D'Amore969bc942010-07-29 16:07:59 -070042Branches:
43
44 Please talk to the gatekeeper about personal branches. In general,
45 they will be allowed as long as we don't go *too* wild on them.
46
47Gatekeeper: garrett@nexenta.com (Interim)
48IRC channel: #illumos on irc.freenode.net
49Mailing list: developer@lists.illumos.org
50