xref: /titanic_51/usr/src/tools/opensolaris/README.opensolaris.tmpl (revision 3d5869cc80c26887ee2c78b0f35e58f574e97192)
1		     OpenSolaris Buildable Source
2
3Note: if this is your first OpenSolaris installation, please see the
4currently known issues section below to see the minimum build of
5Solaris Express - Community Release required to build and install
6OpenSolaris.  Either an initial install or an upgrade will work,
7provided you use the "Entire Distribution" metacluster.
8
9This delivery of the Buildable Source consists of 4 or 5 pieces:
10
111. encumbered binaries tarball (on-closed-bins-DATE.PLATFORM.tar.bz2)
122. compiler (Sun Studio 11 is the preferred compiler, and it is free
13   for OpenSolaris community members.  You can also use gcc; more on
14   that below.)
153. ON build tools package (SUNWonbld-DATE.PLATFORM.tar.bz2)
164. Pre-built BFU archives (on-bfu-DATE.PLATFORM.tar.bz2)
175. source tarball (on-src-DATE.tar.bz2; numbered builds only)
18
19If you just want to install the pre-built archives, you'll need the ON
20build tools and the BFU archives.  The tar file will unpack the
21archives into archives-DATE/PLATFORM/ (e.g.,
22archives-20050612/i386/).  You should review Section A
23(changes since the last delivery) and Section B (known issues) before
24following the BFU instructions in the Developer's Reference
25(http://hub.opensolaris.org/bin/view/Community+Group+on/devref_toc).
26
27If you want to build from source, you will need the source, compiler,
28ON tools, and "extras" tools.  The encumbered binaries tarball contains
29complete binaries (libraries, kernel modules, commands) that are
30compatible with the source.  These are binaries that cannot be built
31using only the source tarball for one reason or another.  If you wish
32to build the kernel (or some portion of it), or if you wish to build a
33complete set of installable archives, you will want the encumbered
34binaries.
35
36Currently, to obtain source, you can either download the
37on-src-DATE.tar.bz2 tarball if you are downloading a
38build-synchronised delivery.  Or, you can checkout from the Mercurial
39repository; please see instructions at:
40http://hub.opensolaris.org/bin/view/Project+onnv/WebHome
41
42The buildable source contains the source for our high key-strength
43crypto, known as the Encryption Kit (SUNWcry, SUNWcryr, SUNWcryptoint).
44Please note that certain countries restrict the redistribution of
45high key-strength crypto.  If you live in one of these countries,
46it is your responsibility to ensure that you are complying with your
47country's laws in this area.
48
49For general questions on the buildable source, please ask on the
50OpenSolaris Help discussion list (opensolaris-help <at> opensolaris
51<dot> org).  For detailed comments about the code, please use
52OpenSolaris Code discussion list.  Please note that the mailing lists
53are configured to only allow posts via the web forum interface or from
54list subscribers.
55
56
57Currently Known Issues
58----------------------
59	These were some of the major known issues at the time of this
60delivery.  The most recent list is available on the OpenSolaris.org
61website in the Nevada community at:
62http://hub.opensolaris.org/bin/view/Community+Group+on/known_issues
63
64<!-- #include http://hub.opensolaris.org/bin/view/Community+Group+on/known_issues -->
65
66
67Installing from Source
68----------------------
69
70<!-- #include http://hub.opensolaris.org/bin/view/Community+Group+on/install_quickstart -->
71