xref: /titanic_51/usr/src/tools/opensolaris/README.opensolaris.tmpl (revision 61dc244f52b4962ea505abec7e6cbade980d3c53)
1		     OS/Net (ON) binaries for Buildable Source
2
3This delivery of the binaries to enable the Buildable Source consists of 2
4pieces:
5
61. encumbered binaries tarball (on-closed-bins-DATE.PLATFORM.tar.bz2)
72. signed cryptographic binaries (on-crypto-DATE.PLATFORM.tar.bz2)
8
9BFU archives are no longer supported.
10
11If you want to build the entire source tree, you will need the source,
12the encumbered binaries, and the cryptographic binaries. The tools may
13be bootstrapped from your source tree.
14
15The encumbered binaries tarball contains complete binaries (libraries,
16kernel modules, commands) that are compatible with the source.  These
17are binaries that cannot be built using only the source tarball for
18one reason or another.
19
20The cryptographic binaries have been signed with a certificate and key
21that enables their use.  The cryptographic binaries that you build
22from source will not be usable unless you have obtained your own
23certificate and key.  See elfsign(1) for more information related to
24signing binaries.
25
26To obtain source, ensure that you have Mercurial installed (if you do
27not, utter 'pkg install developer/versioning/mercurial'), and then
28checkout from the Mercurial repository; please see instructions at:
29http://hub.opensolaris.org/bin/view/Project+onnv/
30
31
32Build Environment
33-----------------
34
35To build from source, you will also need the proper compiler, and you
36must be running a recent build. The build schedule is available at
37http://hub.opensolaris.org/bin/view/Community+Group+on/schedule.
38
39The standard compiler for building OpenSolaris code is Sun Studio,
40which is free to download and use.  You can also use gcc.  See the
41section "Installing from Source" (below) for details.
42
43Build machines are expected to be running an OpenSolaris build that
44is no more than 2 builds behind the source that you're building.  For
45example, if you're building snv_143, your build machine should be
46running snv_141 or later.
47
48
49Other Important Information
50---------------------------
51
52The buildable source contains the source for our high key-strength
53crypto, known as the Encryption Kit (SUNWcry, SUNWcryr, SUNWcryptoint).
54Please note that certain countries restrict the redistribution of
55high key-strength crypto.  If you live in one of these countries,
56it is your responsibility to ensure that you are complying with your
57country's laws in this area.
58
59For general questions on the buildable source, please ask on the
60OpenSolaris Help discussion list (opensolaris-help <at> opensolaris
61<dot> org).  For detailed comments about the code, please use the
62on-discuss list.  Please note that the mailing lists are configured to
63only allow posts from list subscribers.  The Help list also has a web
64forum that is gatewayed with the mailing list.  More information about
65OpenSolaris lists is available at
66http://hub.opensolaris.org/bin/view/Main/discussions.
67
68
69Currently Known Issues
70----------------------
71	These were some of the major known issues at the time of this
72delivery.  The most recent list is available on the OpenSolaris.org
73website in the ON community at:
74http://hub.opensolaris.org/bin/view/Community+Group+on/known_issues
75
76<!-- #include http://hub.opensolaris.org/bin/view/Community+Group+on/known_issues -->
77
78
79Installing from Source
80----------------------
81
82<!-- #include http://hub.opensolaris.org/bin/view/Community+Group+on/install_quickstart -->
83