xref: /titanic_50/README (revision 2ad72058bc680e30f084e9f9ba8ceb0f77386821)
1*2ad72058SGarrett D'Amoreillumos gate README - Sept 12, 2010.
2969bc941SGarrett D'Amore
3*2ad72058SGarrett D'AmoreThis is the illumos gate.  This is the illumos source tree.  It contains
4*2ad72058SGarrett D'Amorethe following subdirectories:
5969bc941SGarrett D'Amore
6*2ad72058SGarrett D'Amore	usr/src	- 		The actual source code
7969bc941SGarrett D'Amore
8*2ad72058SGarrett D'Amore	exception_lists	-	These are lists of exceptional cases
9*2ad72058SGarrett D'Amore				used to limit noise during builds.
10*2ad72058SGarrett D'Amore				Ideally this directory would consist of
11*2ad72058SGarrett D'Amore				only empty files.
12969bc941SGarrett D'Amore
13969bc941SGarrett D'AmoreIntegration Rules:
14969bc941SGarrett D'Amore
15*2ad72058SGarrett D'Amore        All changes must have been reviewed, and approved by and advocate
16*2ad72058SGarrett D'Amore	(below).  A code review may be performed by someone other than the
17*2ad72058SGarrett D'Amore	advocate, but the final integration should still be approved by the
18*2ad72058SGarrett D'Amore	advocate.
19*2ad72058SGarrett D'Amore
20*2ad72058SGarrett D'Amore        The advocate will want to see your webrev and hg outgoing -v.  The
21*2ad72058SGarrett D'Amore	advocate will also ask about your testing, and may ask to see your
22*2ad72058SGarrett D'Amore	build logs.
23969bc941SGarrett D'Amore
24969bc941SGarrett D'Amore        All changes must adhere to typical ON style and quality rules.
25969bc941SGarrett D'Amore        For example, pass full cstyle, applicable lint rules, etc.
26969bc941SGarrett D'Amore
27*2ad72058SGarrett D'Amore        All commits must include either a CDDL license, unless
28*2ad72058SGarrett D'Amore        approved otherwise by the gatekeeper, or the modified code
29*2ad72058SGarrett D'Amore	already carries a different license.  Exceptions shall require
30*2ad72058SGarrett D'Amore	the approval of the gatekeeper.
31969bc941SGarrett D'Amore
32969bc941SGarrett D'Amore        Hg commits should have comments of the following form:
33969bc941SGarrett D'Amore
34969bc941SGarrett D'Amore        1234 This is a sample bug report synopsis
35969bc941SGarrett D'Amore        4567 If you have a second bug synopsis...
36969bc941SGarrett D'Amore        Reviewed by: codereviewer@somewhere.net
37969bc941SGarrett D'Amore        Approved by: gatekeeper@somewhere.else.com
38969bc941SGarrett D'Amore
39*2ad72058SGarrett D'Amore	Each commit must have at least one bug id that is listed in the
40*2ad72058SGarrett D'Amore	illumos-gate project at www.illumos.org.
41*2ad72058SGarrett D'Amore
42969bc941SGarrett D'AmoreBranches:
43969bc941SGarrett D'Amore
44969bc941SGarrett D'Amore        Please talk to the gatekeeper about personal branches.  In general,
45969bc941SGarrett D'Amore        they will be allowed as long as we don't go *too* wild on them.
46969bc941SGarrett D'Amore
47969bc941SGarrett D'AmoreGatekeeper:     garrett@nexenta.com  (Interim)
48969bc941SGarrett D'AmoreIRC channel:    #illumos on irc.freenode.net
49969bc941SGarrett D'AmoreMailing list:   developer@lists.illumos.org
50969bc941SGarrett D'Amore
51