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