xref: /titanic_51/usr/src/tools/opensolaris/README.opensolaris.tmpl (revision 78add226e8da271dde8f3b5a91d340d1bf010151)
1*78add226Sjmcp		     OS/Net (ON) binaries for Buildable Source
27a98501bSkupfer
3*78add226SjmcpThis delivery of the binaries to enable the Buildable Source consists of 2
4*78add226Sjmcppieces:
54e5b757fSkupfer
64e5b757fSkupfer1. encumbered binaries tarball (on-closed-bins-DATE.PLATFORM.tar.bz2)
7597bd30bSMike Kupfer2. signed cryptographic binaries (on-crypto-DATE.PLATFORM.tar.bz2)
84e5b757fSkupfer
9*78add226SjmcpBFU archives are no longer supported.
104e5b757fSkupfer
11597bd30bSMike KupferIf you want to build the entire source tree, you will need the source,
12*78add226Sjmcpthe encumbered binaries, and the cryptographic binaries. The tools may
13*78add226Sjmcpbe bootstrapped from your source tree.
144e5b757fSkupfer
15597bd30bSMike KupferThe encumbered binaries tarball contains complete binaries (libraries,
16597bd30bSMike Kupferkernel modules, commands) that are compatible with the source.  These
17597bd30bSMike Kupferare binaries that cannot be built using only the source tarball for
18597bd30bSMike Kupferone reason or another.
19597bd30bSMike Kupfer
20597bd30bSMike KupferThe cryptographic binaries have been signed with a certificate and key
21597bd30bSMike Kupferthat enables their use.  The cryptographic binaries that you build
22597bd30bSMike Kupferfrom source will not be usable unless you have obtained your own
23597bd30bSMike Kupfercertificate and key.  See elfsign(1) for more information related to
24597bd30bSMike Kupfersigning binaries.
25597bd30bSMike Kupfer
26*78add226SjmcpTo obtain source, ensure that you have Mercurial installed (if you do
27*78add226Sjmcpnot, utter 'pkg install developer/versioning/mercurial'), and then
28*78add226Sjmcpcheckout from the Mercurial repository; please see instructions at:
29*78add226Sjmcphttp://hub.opensolaris.org/bin/view/Project+onnv/
30597bd30bSMike Kupfer
31597bd30bSMike Kupfer
32597bd30bSMike KupferBuild Environment
33597bd30bSMike Kupfer-----------------
34597bd30bSMike Kupfer
35597bd30bSMike KupferTo build from source, you will also need the proper compiler, and you
36*78add226Sjmcpmust be running a recent build. The build schedule is available at
37*78add226Sjmcphttp://hub.opensolaris.org/bin/view/Community+Group+on/schedule.
38597bd30bSMike Kupfer
39597bd30bSMike KupferThe standard compiler for building OpenSolaris code is Sun Studio,
40597bd30bSMike Kupferwhich is free to download and use.  You can also use gcc.  See the
41597bd30bSMike Kupfersection "Installing from Source" (below) for details.
42597bd30bSMike Kupfer
43*78add226SjmcpBuild machines are expected to be running an OpenSolaris build that
44*78add226Sjmcpis no more than 2 builds behind the source that you're building.  For
45*78add226Sjmcpexample, if you're building snv_143, your build machine should be
46*78add226Sjmcprunning snv_141 or later.
47597bd30bSMike Kupfer
48597bd30bSMike Kupfer
49597bd30bSMike KupferOther Important Information
50597bd30bSMike Kupfer---------------------------
514e5b757fSkupfer
524e5b757fSkupferThe buildable source contains the source for our high key-strength
534e5b757fSkupfercrypto, known as the Encryption Kit (SUNWcry, SUNWcryr, SUNWcryptoint).
54c3f177eaSPeter Dennis - Sustaining EngineerPlease note that certain countries restrict the redistribution of
554e5b757fSkupferhigh key-strength crypto.  If you live in one of these countries,
564e5b757fSkupferit is your responsibility to ensure that you are complying with your
574e5b757fSkupfercountry's laws in this area.
584e5b757fSkupfer
594e5b757fSkupferFor general questions on the buildable source, please ask on the
604e5b757fSkupferOpenSolaris Help discussion list (opensolaris-help <at> opensolaris
61597bd30bSMike Kupfer<dot> org).  For detailed comments about the code, please use the
62597bd30bSMike Kupferon-discuss list.  Please note that the mailing lists are configured to
63597bd30bSMike Kupferonly allow posts from list subscribers.  The Help list also has a web
64597bd30bSMike Kupferforum that is gatewayed with the mailing list.  More information about
65597bd30bSMike KupferOpenSolaris lists is available at
66597bd30bSMike Kupferhttp://hub.opensolaris.org/bin/view/Main/discussions.
674e5b757fSkupfer
684e5b757fSkupfer
694e5b757fSkupferCurrently Known Issues
704e5b757fSkupfer----------------------
714e5b757fSkupfer	These were some of the major known issues at the time of this
724e5b757fSkupferdelivery.  The most recent list is available on the OpenSolaris.org
73597bd30bSMike Kupferwebsite in the ON community at:
7420440d37SMike Kupferhttp://hub.opensolaris.org/bin/view/Community+Group+on/known_issues
754e5b757fSkupfer
7620440d37SMike Kupfer<!-- #include http://hub.opensolaris.org/bin/view/Community+Group+on/known_issues -->
774e5b757fSkupfer
784e5b757fSkupfer
794e5b757fSkupferInstalling from Source
804e5b757fSkupfer----------------------
814e5b757fSkupfer
8220440d37SMike Kupfer<!-- #include http://hub.opensolaris.org/bin/view/Community+Group+on/install_quickstart -->
83