xref: /titanic_52/README (revision bde2df36223c26750e6e5e801907d885e088ee30)
1*bde2df36SYuri Pankovillumos gate README - Sep 16, 2012.
2969bc941SGarrett D'Amore
32ad72058SGarrett D'AmoreThis is the illumos gate.  This is the illumos source tree.  It contains
42ad72058SGarrett D'Amorethe following subdirectories:
5969bc941SGarrett D'Amore
62ad72058SGarrett D'Amore	usr/src	- 		The actual source code
7969bc941SGarrett D'Amore
82ad72058SGarrett D'Amore	exception_lists	-	These are lists of exceptional cases
92ad72058SGarrett D'Amore				used to limit noise during builds.
102ad72058SGarrett D'Amore				Ideally this directory would consist of
112ad72058SGarrett D'Amore				only empty files.
12969bc941SGarrett D'Amore
13969bc941SGarrett D'AmoreIntegration Rules:
14969bc941SGarrett D'Amore
15*bde2df36SYuri Pankov        All changes must have been reviewed, and approved by an advocate
162ad72058SGarrett D'Amore	(below).  A code review may be performed by someone other than the
172ad72058SGarrett D'Amore	advocate, but the final integration should still be approved by the
182ad72058SGarrett D'Amore	advocate.
192ad72058SGarrett D'Amore
202ad72058SGarrett D'Amore        The advocate will want to see your webrev and hg outgoing -v.  The
212ad72058SGarrett D'Amore	advocate will also ask about your testing, and may ask to see your
222ad72058SGarrett 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*bde2df36SYuri Pankov        All new code must be licensed under CDDL, and modifications to existing
28*bde2df36SYuri Pankov        code may not alter the original license terms.  Integrations of code
29*bde2df36SYuri Pankov        from upstream sources that use another liberal open source license are
30*bde2df36SYuri Pankov        permissible, subject to approval of the advocates or developer council.
31*bde2df36SYuri Pankov        Exceptions to this policy shall require the approval of the developer
32*bde2df36SYuri Pankov        council.
33969bc941SGarrett D'Amore
34*bde2df36SYuri Pankov        Commits should have comments of the following form:
35969bc941SGarrett D'Amore
36969bc941SGarrett D'Amore        1234 This is a sample bug report synopsis
37*bde2df36SYuri Pankov        4567 If you have a second bug synopsis…
38*bde2df36SYuri Pankov        Reviewed by: Frodo Baggins <frodo.baggins@underhill.net>
39*bde2df36SYuri Pankov        Reviewed by: Legolas <elf-coder@mirkwood.org>
40*bde2df36SYuri Pankov        Approved by: Gandalf The Grey <rti-advocate@white-council.com>
41969bc941SGarrett D'Amore
422ad72058SGarrett D'Amore	Each commit must have at least one bug id that is listed in the
432ad72058SGarrett D'Amore	illumos-gate project at www.illumos.org.
442ad72058SGarrett D'Amore
45*bde2df36SYuri PankovRTI Advocates:     advocates@lists.illumos.org
46*bde2df36SYuri PankovDeveloper Council: developer-council@lists.illumos.org
47969bc941SGarrett D'Amore
48969bc941SGarrett D'AmoreIRC channel:       #illumos on irc.freenode.net
49969bc941SGarrett D'AmoreMailing list:      developer@lists.illumos.org
50