README
author Richard Lowe <richlowe@richlowe.net>
Wed, 07 Aug 2013 17:49:24 -0400
changeset 14232 9cc418183cee
parent 13896 8e4bcbc31a4a
permissions -rw-r--r--
4011 ar does weird things with extended ELF sections Reviewed by: Jason King <[email protected]> Reviewed by: Josef 'Jeff' Sipek <[email protected]> Approved by: Robert Mustacchi <[email protected]>
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
     1
illumos gate README - Sep 16, 2012.
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
     2
13187
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
     3
This is the illumos gate.  This is the illumos source tree.  It contains
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
     4
the following subdirectories:
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
     5
13187
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
     6
	usr/src	- 		The actual source code
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
     7
13187
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
     8
	exception_lists	-	These are lists of exceptional cases
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
     9
				used to limit noise during builds.
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    10
				Ideally this directory would consist of
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    11
				only empty files.
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    12
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    13
Integration Rules:
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    14
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    15
        All changes must have been reviewed, and approved by an advocate
13187
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    16
	(below).  A code review may be performed by someone other than the
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    17
	advocate, but the final integration should still be approved by the
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    18
	advocate. 
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    19
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    20
        The advocate will want to see your webrev and hg outgoing -v.  The
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    21
	advocate will also ask about your testing, and may ask to see your
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    22
	build logs.
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    23
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    24
        All changes must adhere to typical ON style and quality rules.
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    25
        For example, pass full cstyle, applicable lint rules, etc.
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    26
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    27
        All new code must be licensed under CDDL, and modifications to existing
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    28
        code may not alter the original license terms.  Integrations of code
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    29
        from upstream sources that use another liberal open source license are
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    30
        permissible, subject to approval of the advocates or developer council.
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    31
        Exceptions to this policy shall require the approval of the developer
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    32
        council.
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    33
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    34
        Commits should have comments of the following form:
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    35
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    36
        1234 This is a sample bug report synopsis
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    37
        4567 If you have a second bug synopsis…
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    38
        Reviewed by: Frodo Baggins <[email protected]>
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    39
        Reviewed by: Legolas <[email protected]>
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    40
        Approved by: Gandalf The Grey <[email protected]>
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    41
13187
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    42
	Each commit must have at least one bug id that is listed in the
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    43
	illumos-gate project at www.illumos.org.
36a51d4e554c 188 should keep unused closed-bins out of the proto area
Garrett D'Amore <garrett@nexenta.com>
parents: 12780
diff changeset
    44
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    45
RTI Advocates:     [email protected]
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    46
Developer Council: [email protected]
12780
c39281da15f8 1 Need README & TODO for Illumos project
Garrett D'Amore <garrett@nexenta.com>
parents:
diff changeset
    47
13896
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    48
IRC channel:       #illumos on irc.freenode.net
8e4bcbc31a4a 1126 date(1)'s usage message doesn't mention -R
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13187
diff changeset
    49
Mailing list:      [email protected]