common/doc/building.html
author ihse
Mon, 13 Mar 2017 14:01:24 +0100
changeset 44078 673240c54c2e
parent 41040 README-builds.html@7b919a4497ff
child 45103 85999d3d05f0
permissions -rw-r--r--
8176509: Use pandoc for converting build readme to html Reviewed-by: erikj
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     2
<html xmlns="http://www.w3.org/1999/xhtml">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     3
<head>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     4
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     5
  <meta http-equiv="Content-Style-Type" content="text/css" />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     6
  <meta name="generator" content="pandoc" />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     7
  <title>OpenJDK Build README</title>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     8
  <style type="text/css">code{white-space: pre;}</style>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     9
</head>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    10
<body>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    11
<div id="header">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    12
<h1 class="title">OpenJDK Build README</h1>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    13
</div>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    14
<div class="figure">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    15
<img src="http://openjdk.java.net/images/openjdk.png" alt="OpenJDK" />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    16
<p class="caption">OpenJDK</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    17
</div>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    18
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    19
<h2 id="introduction">Introduction</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    20
<p>This README file contains build instructions for the <a href="http://openjdk.java.net">OpenJDK</a>. Building the source code for the OpenJDK requires a certain degree of technical expertise.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    21
<h3 id="this-is-a-major-re-write-of-this-document.">!!!!!!!!!!!!!!! THIS IS A MAJOR RE-WRITE of this document. !!!!!!!!!!!!!</h3>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    22
<p>Some Headlines:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    23
<ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    24
<li>The build is now a &quot;<code>configure &amp;&amp; make</code>&quot; style build</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    25
<li>Any GNU make 3.81 or newer should work, except on Windows where 4.0 or newer is recommended.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    26
<li>The build should scale, i.e. more processors should cause the build to be done in less wall-clock time</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    27
<li>Nested or recursive make invocations have been significantly reduced, as has the total fork/exec or spawning of sub processes during the build</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    28
<li>Windows MKS usage is no longer supported</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    29
<li>Windows Visual Studio <code>vsvars*.bat</code> and <code>vcvars*.bat</code> files are run automatically</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    30
<li>Ant is no longer used when building the OpenJDK</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    31
<li>Use of ALT_* environment variables for configuring the build is no longer supported</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    32
</ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    33
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    34
<h2 id="contents">Contents</h2>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    35
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    36
<li><a href="#introduction">Introduction</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    37
<li><a href="#hg">Use of Mercurial</a>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    38
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    39
<li><a href="#get_source">Getting the Source</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    40
<li><a href="#repositories">Repositories</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    41
</ul></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    42
<li><a href="#building">Building</a>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    43
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    44
<li><a href="#setup">System Setup</a>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    45
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    46
<li><a href="#linux">Linux</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    47
<li><a href="#solaris">Solaris</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    48
<li><a href="#macosx">Mac OS X</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    49
<li><a href="#windows">Windows</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    50
</ul></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    51
<li><a href="#configure">Configure</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    52
<li><a href="#make">Make</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    53
</ul></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    54
<li><a href="#testing">Testing</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    55
</ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    56
<hr />
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    57
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    58
<li><a href="#hints">Appendix A: Hints and Tips</a>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    59
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    60
<li><a href="#faq">FAQ</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    61
<li><a href="#performance">Build Performance Tips</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    62
<li><a href="#troubleshooting">Troubleshooting</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    63
</ul></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    64
<li><a href="#gmake">Appendix B: GNU Make Information</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    65
<li><a href="#buildenvironments">Appendix C: Build Environments</a></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    66
</ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    67
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    68
<h2 id="use-of-mercurial">Use of Mercurial</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    69
<p>The OpenJDK sources are maintained with the revision control system <a href="http://mercurial.selenic.com/wiki/Mercurial">Mercurial</a>. If you are new to Mercurial, please see the <a href="http://mercurial.selenic.com/wiki/BeginnersGuides">Beginner Guides</a> or refer to the <a href="http://hgbook.red-bean.com/">Mercurial Book</a>. The first few chapters of the book provide an excellent overview of Mercurial, what it is and how it works.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    70
<p>For using Mercurial with the OpenJDK refer to the <a href="http://openjdk.java.net/guide/repositories.html#installConfig">Developer Guide: Installing and Configuring Mercurial</a> section for more information.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    71
<h3 id="getting-the-source">Getting the Source</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    72
<p>To get the entire set of OpenJDK Mercurial repositories use the script <code>get_source.sh</code> located in the root repository:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    73
<pre><code>  hg clone http://hg.openjdk.java.net/jdk9/jdk9 YourOpenJDK
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    74
  cd YourOpenJDK
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    75
  bash ./get_source.sh</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    76
<p>Once you have all the repositories, keep in mind that each repository is its own independent repository. You can also re-run <code>./get_source.sh</code> anytime to pull over all the latest changesets in all the repositories. This set of nested repositories has been given the term &quot;forest&quot; and there are various ways to apply the same <code>hg</code> command to each of the repositories. For example, the script <code>make/scripts/hgforest.sh</code> can be used to repeat the same <code>hg</code> command on every repository, e.g.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    77
<pre><code>  cd YourOpenJDK
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    78
  bash ./make/scripts/hgforest.sh status</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    79
<h3 id="repositories">Repositories</h3>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    80
<p>The set of repositories and what they contain:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    81
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    82
<li><strong>. (root)</strong> contains common configure and makefile logic</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    83
<li><strong>hotspot</strong> contains source code and make files for building the OpenJDK Hotspot Virtual Machine</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    84
<li><strong>langtools</strong> contains source code for the OpenJDK javac and language tools</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    85
<li><strong>jdk</strong> contains source code and make files for building the OpenJDK runtime libraries and misc files</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    86
<li><strong>jaxp</strong> contains source code for the OpenJDK JAXP functionality</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    87
<li><strong>jaxws</strong> contains source code for the OpenJDK JAX-WS functionality</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    88
<li><strong>corba</strong> contains source code for the OpenJDK Corba functionality</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    89
<li><strong>nashorn</strong> contains source code for the OpenJDK JavaScript implementation</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    90
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    91
<h3 id="repository-source-guidelines">Repository Source Guidelines</h3>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    92
<p>There are some very basic guidelines:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    93
<ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    94
<li>Use of whitespace in source files (.java, .c, .h, .cpp, and .hpp files) is restricted. No TABs, no trailing whitespace on lines, and files should not terminate in more than one blank line.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    95
<li>Files with execute permissions should not be added to the source repositories.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    96
<li>All generated files need to be kept isolated from the files maintained or managed by the source control system. The standard area for generated files is the top level <code>build/</code> directory.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    97
<li>The default build process should be to build the product and nothing else, in one form, e.g. a product (optimized), debug (non-optimized, -g plus assert logic), or fastdebug (optimized, -g plus assert logic).</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    98
<li>The <code>.hgignore</code> file in each repository must exist and should include <code>^build/</code>, <code>^dist/</code> and optionally any <code>nbproject/private</code> directories. <strong>It should NEVER</strong> include anything in the <code>src/</code> or <code>test/</code> or any managed directory area of a repository.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    99
<li>Directory names and file names should never contain blanks or non-printing characters.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   100
<li>Generated source or binary files should NEVER be added to the repository (that includes <code>javah</code> output). There are some exceptions to this rule, in particular with some of the generated configure scripts.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   101
<li>Files not needed for typical building or testing of the repository should not be added to the repository.</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   102
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   103
<hr />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   104
<h2 id="building">Building</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   105
<p>The very first step in building the OpenJDK is making sure the system itself has everything it needs to do OpenJDK builds. Once a system is setup, it generally doesn't need to be done again.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   106
<p>Building the OpenJDK is now done with running a <code>configure</code> script which will try and find and verify you have everything you need, followed by running <code>make</code>, e.g.</p>
34595
09596fe63e2d 8145391: Updated jprt.properties, devtools, jib and readme with SS12u4
erikj
parents: 33030
diff changeset
   107
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   108
<p><strong><code>bash ./configure</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   109
<strong><code>make all</code></strong></p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   110
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   111
<p>Where possible the <code>configure</code> script will attempt to located the various components in the default locations or via component specific variable settings. When the normal defaults fail or components cannot be found, additional <code>configure</code> options may be necessary to help <code>configure</code> find the necessary tools for the build, or you may need to re-visit the setup of your system due to missing software packages.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   112
<p><strong>NOTE:</strong> The <code>configure</code> script file does not have execute permissions and will need to be explicitly run with <code>bash</code>, see the source guidelines.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   113
<hr />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   114
<h3 id="system-setup">System Setup</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   115
<p>Before even attempting to use a system to build the OpenJDK there are some very basic system setups needed. For all systems:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   116
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   117
<li>Be sure the GNU make utility is version 3.81 (4.0 on windows) or newer, e.g. run &quot;<code>make -version</code>&quot;</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   118
</ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   119
<p><a name="bootjdk"></a> * Install a Bootstrap JDK. All OpenJDK builds require access to a previously released JDK called the <em>bootstrap JDK</em> or <em>boot JDK.</em> The general rule is that the bootstrap JDK must be an instance of the previous major release of the JDK. In addition, there may be a requirement to use a release at or beyond a particular update level.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   120
<p><strong><em>Building JDK 9 requires JDK 8. JDK 9 developers should not use JDK 9 as the boot JDK, to ensure that JDK 9 dependencies are not introduced into the parts of the system that are built with JDK 8.</em></strong></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   121
<p>The JDK 8 binaries can be downloaded from Oracle's <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK 8 download site</a>. For build performance reasons it is very important that this bootstrap JDK be made available on the local disk of the machine doing the build. You should add its <code>bin</code> directory to the <code>PATH</code> environment variable. If <code>configure</code> has any issues finding this JDK, you may need to use the <code>configure</code> option <code>--with-boot-jdk</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   122
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   123
<li>Ensure that GNU make, the Bootstrap JDK, and the compilers are all in your PATH environment variable.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   124
</ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   125
<p>And for specific systems:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   126
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   127
<li><strong>Linux</strong></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   128
</ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   129
<p>Install all the software development packages needed including <a href="#alsa">alsa</a>, <a href="#freetype">freetype</a>, <a href="#cups">cups</a>, and <a href="#xrender">xrender</a>. See <a href="#SDBE">specific system packages</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   130
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   131
<li><strong>Solaris</strong></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   132
</ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   133
<p>Install all the software development packages needed including <a href="#studio">Studio Compilers</a>, <a href="#freetype">freetype</a>, <a href="#cups">cups</a>, and <a href="#xrender">xrender</a>. See <a href="#SDBE">specific system packages</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   134
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   135
<li><p><strong>Windows</strong></p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   136
<li>Install one of <a href="#cygwin">CYGWIN</a> or <a href="#msys">MinGW/MSYS</a></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   137
<li><p>Install <a href="#vs2013">Visual Studio 2013</a></p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   138
<li><p><strong>Mac OS X</strong></p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   139
</ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   140
<p>Install <a href="https://developer.apple.com/xcode/">XCode 6.3</a></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   141
<h4 id="linux">Linux</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   142
<p>With Linux, try and favor the system packages over building your own or getting packages from other areas. Most Linux builds should be possible with the system's available packages.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   143
<p>Note that some Linux systems have a habit of pre-populating your environment variables for you, for example <code>JAVA_HOME</code> might get pre-defined for you to refer to the JDK installed on your Linux system. You will need to unset <code>JAVA_HOME</code>. It's a good idea to run <code>env</code> and verify the environment variables you are getting from the default system settings make sense for building the OpenJDK.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   144
<h4 id="solaris">Solaris</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   145
<h5 id="studio-compilers">Studio Compilers</h5>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   146
<p>At a minimum, the <a href="http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index.htm">Studio 12 Update 4 Compilers</a> (containing version 5.13 of the C and C++ compilers) is required, including specific patches.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   147
<p>The Solaris Studio installation should contain at least these packages:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   148
<table>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   149
<thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   150
<tr class="header">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   151
<th align="left">Package</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   152
<th align="left">Version</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   153
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   154
</thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   155
<tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   156
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   157
<td align="left">developer/solarisstudio-124/backend</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   158
<td align="left">12.4-1.0.6.0</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   159
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   160
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   161
<td align="left">developer/solarisstudio-124/c++</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   162
<td align="left">12.4-1.0.10.0</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   163
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   164
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   165
<td align="left">developer/solarisstudio-124/cc</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   166
<td align="left">12.4-1.0.4.0</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   167
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   168
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   169
<td align="left">developer/solarisstudio-124/library/c++-libs</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   170
<td align="left">12.4-1.0.10.0</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   171
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   172
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   173
<td align="left">developer/solarisstudio-124/library/math-libs</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   174
<td align="left">12.4-1.0.0.1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   175
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   176
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   177
<td align="left">developer/solarisstudio-124/library/studio-gccrt</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   178
<td align="left">12.4-1.0.0.1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   179
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   180
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   181
<td align="left">developer/solarisstudio-124/studio-common</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   182
<td align="left">12.4-1.0.0.1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   183
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   184
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   185
<td align="left">developer/solarisstudio-124/studio-ja</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   186
<td align="left">12.4-1.0.0.1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   187
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   188
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   189
<td align="left">developer/solarisstudio-124/studio-legal</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   190
<td align="left">12.4-1.0.0.1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   191
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   192
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   193
<td align="left">developer/solarisstudio-124/studio-zhCN</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   194
<td align="left">12.4-1.0.0.1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   195
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   196
</tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   197
</table>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   198
<p>In particular backend 12.4-1.0.6.0 contains a critical patch for the sparc version.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   199
<p>Place the <code>bin</code> directory in <code>PATH</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   200
<p>The Oracle Solaris Studio Express compilers at: <a href="http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index-jsp-142582.html">Oracle Solaris Studio Express Download site</a> are also an option, although these compilers have not been extensively used yet.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   201
<h4 id="windows">Windows</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   202
<h5 id="windows-unix-toolkit">Windows Unix Toolkit</h5>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   203
<p>Building on Windows requires a Unix-like environment, notably a Unix-like shell. There are several such environments available of which <a href="http://www.cygwin.com/">Cygwin</a> and <a href="http://www.mingw.org/wiki/MSYS">MinGW/MSYS</a> are currently supported for the OpenJDK build. One of the differences of these systems from standard Windows tools is the way they handle Windows path names, particularly path names which contain spaces, backslashes as path separators and possibly drive letters. Depending on the use case and the specifics of each environment these path problems can be solved by a combination of quoting whole paths, translating backslashes to forward slashes, escaping backslashes with additional backslashes and translating the path names to their <a href="http://en.wikipedia.org/wiki/8.3_filename">&quot;8.3&quot; version</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   204
<h6 id="cygwin">CYGWIN</h6>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   205
<p>CYGWIN is an open source, Linux-like environment which tries to emulate a complete POSIX layer on Windows. It tries to be smart about path names and can usually handle all kinds of paths if they are correctly quoted or escaped although internally it maps drive letters <code>&lt;drive&gt;:</code> to a virtual directory <code>/cygdrive/&lt;drive&gt;</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   206
<p>You can always use the <code>cygpath</code> utility to map pathnames with spaces or the backslash character into the <code>C:/</code> style of pathname (called 'mixed'), e.g. <code>cygpath -s -m &quot;&lt;path&gt;&quot;</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   207
<p>Note that the use of CYGWIN creates a unique problem with regards to setting <a href="#path"><code>PATH</code></a>. Normally on Windows the <code>PATH</code> variable contains directories separated with the &quot;;&quot; character (Solaris and Linux use &quot;:&quot;). With CYGWIN, it uses &quot;:&quot;, but that means that paths like &quot;C:/path&quot; cannot be placed in the CYGWIN version of <code>PATH</code> and instead CYGWIN uses something like <code>/cygdrive/c/path</code> which CYGWIN understands, but only CYGWIN understands.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   208
<p>The OpenJDK build requires CYGWIN version 1.7.16 or newer. Information about CYGWIN can be obtained from the CYGWIN website at <a href="http://www.cygwin.com">www.cygwin.com</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   209
<p>By default CYGWIN doesn't install all the tools required for building the OpenJDK. Along with the default installation, you need to install the following tools.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   210
<table>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   211
<thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   212
<tr class="header">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   213
<th align="left">Binary Name</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   214
<th align="left">Category</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   215
<th align="left">Package</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   216
<th align="left">Description</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   217
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   218
</thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   219
<tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   220
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   221
<td align="left">ar.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   222
<td align="left">Devel</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   223
<td align="left">binutils</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   224
<td align="left">The GNU assembler, linker and binary utilities</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   225
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   226
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   227
<td align="left">make.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   228
<td align="left">Devel</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   229
<td align="left">make</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   230
<td align="left">The GNU version of the 'make' utility built for CYGWIN</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   231
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   232
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   233
<td align="left">m4.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   234
<td align="left">Interpreters</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   235
<td align="left">m4</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   236
<td align="left">GNU implementation of the traditional Unix macro processor</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   237
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   238
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   239
<td align="left">cpio.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   240
<td align="left">Utils</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   241
<td align="left">cpio</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   242
<td align="left">A program to manage archives of files</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   243
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   244
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   245
<td align="left">gawk.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   246
<td align="left">Utils</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   247
<td align="left">awk</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   248
<td align="left">Pattern-directed scanning and processing language</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   249
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   250
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   251
<td align="left">file.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   252
<td align="left">Utils</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   253
<td align="left">file</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   254
<td align="left">Determines file type using 'magic' numbers</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   255
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   256
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   257
<td align="left">zip.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   258
<td align="left">Archive</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   259
<td align="left">zip</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   260
<td align="left">Package and compress (archive) files</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   261
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   262
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   263
<td align="left">unzip.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   264
<td align="left">Archive</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   265
<td align="left">unzip</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   266
<td align="left">Extract compressed files in a ZIP archive</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   267
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   268
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   269
<td align="left">free.exe</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   270
<td align="left">System</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   271
<td align="left">procps</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   272
<td align="left">Display amount of free and used memory in the system</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   273
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   274
</tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   275
</table>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   276
<p>Note that the CYGWIN software can conflict with other non-CYGWIN software on your Windows system. CYGWIN provides a <a href="http://cygwin.com/faq/faq.using.html">FAQ</a> for known issues and problems, of particular interest is the section on <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda">BLODA (applications that interfere with CYGWIN)</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   277
<h6 id="mingwmsys">MinGW/MSYS</h6>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   278
<p>MinGW (&quot;Minimalist GNU for Windows&quot;) is a collection of free Windows specific header files and import libraries combined with GNU toolsets that allow one to produce native Windows programs that do not rely on any 3rd-party C runtime DLLs. MSYS is a supplement to MinGW which allows building applications and programs which rely on traditional UNIX tools to be present. Among others this includes tools like <code>bash</code> and <code>make</code>. See <a href="http://www.mingw.org/wiki/MSYS">MinGW/MSYS</a> for more information.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   279
<p>Like Cygwin, MinGW/MSYS can handle different types of path formats. They are internally converted to paths with forward slashes and drive letters <code>&lt;drive&gt;:</code> replaced by a virtual directory <code>/&lt;drive&gt;</code>. Additionally, MSYS automatically detects binaries compiled for the MSYS environment and feeds them with the internal, Unix-style path names. If native Windows applications are called from within MSYS programs their path arguments are automatically converted back to Windows style path names with drive letters and backslashes as path separators. This may cause problems for Windows applications which use forward slashes as parameter separator (e.g. <code>cl /nologo /I</code>) because MSYS may wrongly <a href="http://mingw.org/wiki/Posix_path_conversion">replace such parameters by drive letters</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   280
<p>In addition to the tools which will be installed by default, you have to manually install the <code>msys-zip</code> and <code>msys-unzip</code> packages. This can be easily done with the MinGW command line installer:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   281
<pre><code>  mingw-get.exe install msys-zip
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   282
  mingw-get.exe install msys-unzip</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   283
<h5 id="visual-studio-2013-compilers">Visual Studio 2013 Compilers</h5>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   284
<p>The 32-bit and 64-bit OpenJDK Windows build requires Microsoft Visual Studio C++ 2013 (VS2013) Professional Edition or Express compiler. The compiler and other tools are expected to reside in the location defined by the variable <code>VS120COMNTOOLS</code> which is set by the Microsoft Visual Studio installer.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   285
<p>Only the C++ part of VS2013 is needed. Try to let the installation go to the default install directory. Always reboot your system after installing VS2013. The system environment variable VS120COMNTOOLS should be set in your environment.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   286
<p>Make sure that TMP and TEMP are also set in the environment and refer to Windows paths that exist, like <code>C:\temp</code>, not <code>/tmp</code>, not <code>/cygdrive/c/temp</code>, and not <code>C:/temp</code>. <code>C:\temp</code> is just an example, it is assumed that this area is private to the user, so by default after installs you should see a unique user path in these variables.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   287
<h4 id="mac-os-x">Mac OS X</h4>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   288
<p>Make sure you get the right XCode version.</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   289
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   290
<h3 id="configure">Configure</h3>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   291
<p>The basic invocation of the <code>configure</code> script looks like:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   292
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   293
<p><strong><code>bash ./configure [options]</code></strong></p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   294
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   295
<p>This will create an output directory containing the &quot;configuration&quot; and setup an area for the build result. This directory typically looks like:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   296
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   297
<p><strong><code>build/linux-x64-normal-server-release</code></strong></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   298
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   299
<p><code>configure</code> will try to figure out what system you are running on and where all necessary build components are. If you have all prerequisites for building installed, it should find everything. If it fails to detect any component automatically, it will exit and inform you about the problem. When this happens, read more below in <a href="#configureoptions">the <code>configure</code> options</a>.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   300
<p>Some examples:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   301
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   302
<p><strong>Windows 32bit build with freetype specified:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   303
<code>bash ./configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-bits=32</code></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   304
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   305
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   306
<p><strong>Debug 64bit Build:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   307
<code>bash ./configure --enable-debug --with-target-bits=64</code></p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   308
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   309
<h4 id="configure-options">Configure Options</h4>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   310
<p>Complete details on all the OpenJDK <code>configure</code> options can be seen with:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   311
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   312
<p><strong><code>bash ./configure --help=short</code></strong></p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   313
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   314
<p>Use <code>-help</code> to see all the <code>configure</code> options available. You can generate any number of different configurations, e.g. debug, release, 32, 64, etc.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   315
<p>Some of the more commonly used <code>configure</code> options are:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   316
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   317
<p><strong><code>--enable-debug</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   318
set the debug level to fastdebug (this is a shorthand for <code>--with-debug-level=fastdebug</code>)</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   319
</blockquote>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   320
<p><a name="alsa"></a></p>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   321
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   322
<p><strong><code>--with-alsa=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   323
select the location of the Advanced Linux Sound Architecture (ALSA)</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   324
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   325
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   326
<p>Version 0.9.1 or newer of the ALSA files are required for building the OpenJDK on Linux. These Linux files are usually available from an &quot;alsa&quot; of &quot;libasound&quot; development package, and it's highly recommended that you try and use the package provided by the particular version of Linux that you are using.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   327
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   328
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   329
<p><strong><code>--with-boot-jdk=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   330
select the <a href="#bootjdk">Bootstrap JDK</a></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   331
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   332
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   333
<p><strong><code>--with-boot-jdk-jvmargs=</code></strong>&quot;<em>args</em>&quot;<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   334
provide the JVM options to be used to run the <a href="#bootjdk">Bootstrap JDK</a></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   335
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   336
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   337
<p><strong><code>--with-cacerts=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   338
select the path to the cacerts file.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   339
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   340
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   341
<p>See <a href="http://en.wikipedia.org/wiki/Certificate_Authority">Certificate Authority on Wikipedia</a> for a better understanding of the Certificate Authority (CA). A certificates file named &quot;cacerts&quot; represents a system-wide keystore with CA certificates. In JDK and JRE binary bundles, the &quot;cacerts&quot; file contains root CA certificates from several public CAs (e.g., VeriSign, Thawte, and Baltimore). The source contain a cacerts file without CA root certificates. Formal JDK builders will need to secure permission from each public CA and include the certificates into their own custom cacerts file. Failure to provide a populated cacerts file will result in verification errors of a certificate chain during runtime. By default an empty cacerts file is provided and that should be fine for most JDK developers.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   342
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   343
<p><a name="cups"></a></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   344
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   345
<p><strong><code>--with-cups=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   346
select the CUPS install location</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   347
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   348
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   349
<p>The Common UNIX Printing System (CUPS) Headers are required for building the OpenJDK on Solaris and Linux. The Solaris header files can be obtained by installing the package <strong>print/cups</strong>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   350
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   351
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   352
<p>The CUPS header files can always be downloaded from <a href="http://www.cups.org">www.cups.org</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   353
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   354
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   355
<p><strong><code>--with-cups-include=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   356
select the CUPS include directory location</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   357
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   358
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   359
<p><strong><code>--with-debug-level=</code></strong><em>level</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   360
select the debug information level of release, fastdebug, or slowdebug</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   361
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   362
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   363
<p><strong><code>--with-dev-kit=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   364
select location of the compiler install or developer install location</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   365
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   366
<p><a name="freetype"></a></p>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   367
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   368
<p><strong><code>--with-freetype=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   369
select the freetype files to use.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   370
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   371
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   372
<p>Expecting the freetype libraries under <code>lib/</code> and the headers under <code>include/</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   373
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   374
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   375
<p>Version 2.3 or newer of FreeType is required. On Unix systems required files can be available as part of your distribution (while you still may need to upgrade them). Note that you need development version of package that includes both the FreeType library and header files.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   376
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   377
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   378
<p>You can always download latest FreeType version from the <a href="http://www.freetype.org">FreeType website</a>. Building the freetype 2 libraries from scratch is also possible, however on Windows refer to the <a href="http://freetype.freedesktop.org/wiki/FreeType_DLL">Windows FreeType DLL build instructions</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   379
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   380
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   381
<p>Note that by default FreeType is built with byte code hinting support disabled due to licensing restrictions. In this case, text appearance and metrics are expected to differ from Sun's official JDK build. See the <a href="http://freetype.sourceforge.net/freetype2">SourceForge FreeType2 Home Page</a> for more information.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   382
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   383
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   384
<p><strong><code>--with-import-hotspot=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   385
select the location to find hotspot binaries from a previous build to avoid building hotspot</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   386
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   387
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   388
<p><strong><code>--with-target-bits=</code></strong><em>arg</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   389
select 32 or 64 bit build</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   390
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   391
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   392
<p><strong><code>--with-jvm-variants=</code></strong><em>variants</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   393
select the JVM variants to build from, comma separated list that can include: server, client, kernel, zero and zeroshark</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   394
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   395
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   396
<p><strong><code>--with-memory-size=</code></strong><em>size</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   397
select the RAM size that GNU make will think this system has</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   398
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   399
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   400
<p><strong><code>--with-msvcr-dll=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   401
select the <code>msvcr100.dll</code> file to include in the Windows builds (C/C++ runtime library for Visual Studio).</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   402
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   403
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   404
<p>This is usually picked up automatically from the redist directories of Visual Studio 2013.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   405
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   406
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   407
<p><strong><code>--with-num-cores=</code></strong><em>cores</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   408
select the number of cores to use (processor count or CPU count)</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   409
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   410
<p><a name="xrender"></a></p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   411
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   412
<p><strong><code>--with-x=</code></strong><em>path</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   413
select the location of the X11 and xrender files.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   414
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   415
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   416
<p>The XRender Extension Headers are required for building the OpenJDK on Solaris and Linux. The Linux header files are usually available from a &quot;Xrender&quot; development package, it's recommended that you try and use the package provided by the particular distribution of Linux that you are using. The Solaris XRender header files is included with the other X11 header files in the package <strong>SFWxwinc</strong> on new enough versions of Solaris and will be installed in <code>/usr/X11/include/X11/extensions/Xrender.h</code> or <code>/usr/openwin/share/include/X11/extensions/Xrender.h</code></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   417
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   418
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   419
<h3 id="make">Make</h3>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   420
<p>The basic invocation of the <code>make</code> utility looks like:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   421
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   422
<p><strong><code>make all</code></strong></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   423
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   424
<p>This will start the build to the output directory containing the &quot;configuration&quot; that was created by the <code>configure</code> script. Run <code>make help</code> for more information on the available targets.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   425
<p>There are some of the make targets that are of general interest:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   426
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   427
<p><em>empty</em><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   428
build everything but no images</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   429
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   430
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   431
<p><strong><code>all</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   432
build everything including images</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   433
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   434
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   435
<p><strong><code>all-conf</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   436
build all configurations</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   437
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   438
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   439
<p><strong><code>images</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   440
create complete j2sdk and j2re images</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   441
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   442
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   443
<p><strong><code>install</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   444
install the generated images locally, typically in <code>/usr/local</code></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   445
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   446
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   447
<p><strong><code>clean</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   448
remove all files generated by make, but not those generated by <code>configure</code></p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   449
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   450
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   451
<p><strong><code>dist-clean</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   452
remove all files generated by both and <code>configure</code> (basically killing the configuration)</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   453
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   454
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   455
<p><strong><code>help</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   456
give some help on using <code>make</code>, including some interesting make targets</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   457
</blockquote>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   458
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   459
<h2 id="testing">Testing</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   460
<p>When the build is completed, you should see the generated binaries and associated files in the <code>j2sdk-image</code> directory in the output directory. In particular, the <code>build/*/images/j2sdk-image/bin</code> directory should contain executables for the OpenJDK tools and utilities for that configuration. The testing tool <code>jtreg</code> will be needed and can be found at: <a href="http://openjdk.java.net/jtreg/">the jtreg site</a>. The provided regression tests in the repositories can be run with the command:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   461
<blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   462
<p><strong><code>cd test &amp;&amp; make PRODUCT_HOME=`pwd`/../build/*/images/j2sdk-image all</code></strong></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   463
</blockquote>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   464
<hr />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   465
<h2 id="appendix-a-hints-and-tips">Appendix A: Hints and Tips</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   466
<h3 id="faq">FAQ</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   467
<p><strong>Q:</strong> The <code>generated-configure.sh</code> file looks horrible! How are you going to edit it?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   468
<strong>A:</strong> The <code>generated-configure.sh</code> file is generated (think &quot;compiled&quot;) by the autoconf tools. The source code is in <code>configure.ac</code> and various .m4 files in common/autoconf, which are much more readable.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   469
<p><strong>Q:</strong> Why is the <code>generated-configure.sh</code> file checked in, if it is generated?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   470
<strong>A:</strong> If it was not generated, every user would need to have the autoconf tools installed, and re-generate the <code>configure</code> file as the first step. Our goal is to minimize the work needed to be done by the user to start building OpenJDK, and to minimize the number of external dependencies required.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   471
<p><strong>Q:</strong> Do you require a specific version of autoconf for regenerating <code>generated-configure.sh</code>?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   472
<strong>A:</strong> Yes, version 2.69 is required and should be easy enough to aquire on all supported operating systems. The reason for this is to avoid large spurious changes in <code>generated-configure.sh</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   473
<p><strong>Q:</strong> How do you regenerate <code>generated-configure.sh</code> after making changes to the input files?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   474
<strong>A:</strong> Regnerating <code>generated-configure.sh</code> should always be done using the script <code>common/autoconf/autogen.sh</code> to ensure that the correct files get updated. This script should also be run after mercurial tries to merge <code>generated-configure.sh</code> as a merge of the generated file is not guaranteed to be correct.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   475
<p><strong>Q:</strong> What are the files in <code>common/makefiles/support/*</code> for? They look like gibberish.<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   476
<strong>A:</strong> They are a somewhat ugly hack to compensate for command line length limitations on certain platforms (Windows, Solaris). Due to a combination of limitations in make and the shell, command lines containing too many files will not work properly. These helper files are part of an elaborate hack that will compress the command line in the makefile and then uncompress it safely. We're not proud of it, but it does fix the problem. If you have any better suggestions, we're all ears! :-)</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   477
<p><strong>Q:</strong> I want to see the output of the commands that make runs, like in the old build. How do I do that?<br />
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   478
<strong>A:</strong> You specify the <code>LOG</code> variable to make. There are several log levels:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   479
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   480
<li><strong><code>warn</code></strong> -- Default and very quiet.</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   481
<li><strong><code>info</code></strong> -- Shows more progress information than warn.</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   482
<li><strong><code>debug</code></strong> -- Echos all command lines and prints all macro calls for compilation definitions.</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   483
<li><strong><code>trace</code></strong> -- Echos all $(shell) command lines as well.</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   484
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   485
<p><strong>Q:</strong> When do I have to re-run <code>configure</code>?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   486
<strong>A:</strong> Normally you will run <code>configure</code> only once for creating a configuration. You need to re-run configuration only if you want to change any configuration options, or if you pull down changes to the <code>configure</code> script.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   487
<p><strong>Q:</strong> I have added a new source file. Do I need to modify the makefiles?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   488
<strong>A:</strong> Normally, no. If you want to create e.g. a new native library, you will need to modify the makefiles. But for normal file additions or removals, no changes are needed. There are certan exceptions for some native libraries where the source files are spread over many directories which also contain sources for other libraries. In these cases it was simply easier to create include lists rather than excludes.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   489
<p><strong>Q:</strong> When I run <code>configure --help</code>, I see many strange options, like <code>--dvidir</code>. What is this?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   490
<strong>A:</strong> Configure provides a slew of options by default, to all projects that use autoconf. Most of them are not used in OpenJDK, so you can safely ignore them. To list only OpenJDK specific features, use <code>configure --help=short</code> instead.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   491
<p><strong>Q:</strong> <code>configure</code> provides OpenJDK-specific features such as <code>--with-builddeps-server</code> that are not described in this document. What about those?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   492
<strong>A:</strong> Try them out if you like! But be aware that most of these are experimental features. Many of them don't do anything at all at the moment; the option is just a placeholder. Others depend on pieces of code or infrastructure that is currently not ready for prime time.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   493
<p><strong>Q:</strong> How will you make sure you don't break anything?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   494
<strong>A:</strong> We have a script that compares the result of the new build system with the result of the old. For most part, we aim for (and achieve) byte-by-byte identical output. There are however technical issues with e.g. native binaries, which might differ in a byte-by-byte comparison, even when building twice with the old build system. For these, we compare relevant aspects (e.g. the symbol table and file size). Note that we still don't have 100% equivalence, but we're close.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   495
<p><strong>Q:</strong> I noticed this thing X in the build that looks very broken by design. Why don't you fix it?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   496
<strong>A:</strong> Our goal is to produce a build output that is as close as technically possible to the old build output. If things were weird in the old build, they will be weird in the new build. Often, things were weird before due to obscurity, but in the new build system the weird stuff comes up to the surface. The plan is to attack these things at a later stage, after the new build system is established.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   497
<p><strong>Q:</strong> The code in the new build system is not that well-structured. Will you fix this?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   498
<strong>A:</strong> Yes! The new build system has grown bit by bit as we converted the old system. When all of the old build system is converted, we can take a step back and clean up the structure of the new build system. Some of this we plan to do before replacing the old build system and some will need to wait until after.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   499
<p><strong>Q:</strong> Is anything able to use the results of the new build's default make target?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   500
<strong>A:</strong> Yes, this is the minimal (or roughly minimal) set of compiled output needed for a developer to actually execute the newly built JDK. The idea is that in an incremental development fashion, when doing a normal make, you should only spend time recompiling what's changed (making it purely incremental) and only do the work that's needed to actually run and test your code. The packaging stuff that is part of the <code>images</code> target is not needed for a normal developer who wants to test his new code. Even if it's quite fast, it's still unnecessary. We're targeting sub-second incremental rebuilds! ;-) (Or, well, at least single-digit seconds...)</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   501
<p><strong>Q:</strong> I usually set a specific environment variable when building, but I can't find the equivalent in the new build. What should I do?<br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   502
<strong>A:</strong> It might very well be that we have neglected to add support for an option that was actually used from outside the build system. Email us and we will add support for it!</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   503
<h3 id="build-performance-tips">Build Performance Tips</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   504
<p>Building OpenJDK requires a lot of horsepower. Some of the build tools can be adjusted to utilize more or less of resources such as parallel threads and memory. The <code>configure</code> script analyzes your system and selects reasonable values for such options based on your hardware. If you encounter resource problems, such as out of memory conditions, you can modify the detected values with:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   505
<ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   506
<li><strong><code>--with-num-cores</code></strong> -- number of cores in the build system, e.g. <code>--with-num-cores=8</code></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   507
<li><strong><code>--with-memory-size</code></strong> -- memory (in MB) available in the build system, e.g. <code>--with-memory-size=1024</code></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   508
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   509
<p>It might also be necessary to specify the JVM arguments passed to the Bootstrap JDK, using e.g. <code>--with-boot-jdk-jvmargs=&quot;-Xmx8G -enableassertions&quot;</code>. Doing this will override the default JVM arguments passed to the Bootstrap JDK.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   510
<p>One of the top goals of the new build system is to improve the build performance and decrease the time needed to build. This will soon also apply to the java compilation when the Smart Javac wrapper is fully supported.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   511
<p>At the end of a successful execution of <code>configure</code>, you will get a performance summary, indicating how well the build will perform. Here you will also get performance hints. If you want to build fast, pay attention to those!</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   512
<h4 id="building-with-ccache">Building with ccache</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   513
<p>The OpenJDK build supports building with ccache when using gcc or clang. Using ccache can radically speed up compilation of native code if you often rebuild the same sources. Your milage may vary however so we recommend evaluating it for yourself. To enable it, make sure it's on the path and configure with <code>--enable-ccache</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   514
<h4 id="building-on-local-disk">Building on local disk</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   515
<p>If you are using network shares, e.g. via NFS, for your source code, make sure the build directory is situated on local disk. The performance penalty is extremely high for building on a network share, close to unusable.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   516
<h4 id="building-only-one-jvm">Building only one JVM</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   517
<p>The old build builds multiple JVMs on 32-bit systems (client and server; and on Windows kernel as well). In the new build we have changed this default to only build server when it's available. This improves build times for those not interested in multiple JVMs. To mimic the old behavior on platforms that support it, use <code>--with-jvm-variants=client,server</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   518
<h4 id="selecting-the-number-of-cores-to-build-on">Selecting the number of cores to build on</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   519
<p>By default, <code>configure</code> will analyze your machine and run the make process in parallel with as many threads as you have cores. This behavior can be overridden, either &quot;permanently&quot; (on a <code>configure</code> basis) using <code>--with-num-cores=N</code> or for a single build only (on a make basis), using <code>make JOBS=N</code>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   520
<p>If you want to make a slower build just this time, to save some CPU power for other processes, you can run e.g. <code>make JOBS=2</code>. This will force the makefiles to only run 2 parallel processes, or even <code>make JOBS=1</code> which will disable parallelism.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   521
<p>If you want to have it the other way round, namely having slow builds default and override with fast if you're impatient, you should call <code>configure</code> with <code>--with-num-cores=2</code>, making 2 the default. If you want to run with more cores, run <code>make JOBS=8</code></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   522
<h3 id="troubleshooting">Troubleshooting</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   523
<h4 id="solving-build-problems">Solving build problems</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   524
<p>If the build fails (and it's not due to a compilation error in a source file you've changed), the first thing you should do is to re-run the build with more verbosity. Do this by adding <code>LOG=debug</code> to your make command line.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   525
<p>The build log (with both stdout and stderr intermingled, basically the same as you see on your console) can be found as <code>build.log</code> in your build directory.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   526
<p>You can ask for help on build problems with the new build system on either the <a href="http://mail.openjdk.java.net/mailman/listinfo/build-dev">build-dev</a> or the <a href="http://mail.openjdk.java.net/mailman/listinfo/build-infra-dev">build-infra-dev</a> mailing lists. Please include the relevant parts of the build log.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   527
<p>A build can fail for any number of reasons. Most failures are a result of trying to build in an environment in which all the pre-build requirements have not been met. The first step in troubleshooting a build failure is to recheck that you have satisfied all the pre-build requirements for your platform. Scanning the <code>configure</code> log is a good first step, making sure that what it found makes sense for your system. Look for strange error messages or any difficulties that <code>configure</code> had in finding things.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   528
<p>Some of the more common problems with builds are briefly described below, with suggestions for remedies.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   529
<ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   530
<li><p><strong>Corrupted Bundles on Windows:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   531
Some virus scanning software has been known to corrupt the downloading of zip bundles. It may be necessary to disable the 'on access' or 'real time' virus scanning features to prevent this corruption. This type of 'real time' virus scanning can also slow down the build process significantly. Temporarily disabling the feature, or excluding the build output directory may be necessary to get correct and faster builds.</p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   532
<li><p><strong>Slow Builds:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   533
If your build machine seems to be overloaded from too many simultaneous C++ compiles, try setting the <code>JOBS=1</code> on the <code>make</code> command line. Then try increasing the count slowly to an acceptable level for your system. Also:</p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   534
</ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   535
<p>Creating the javadocs can be very slow, if you are running javadoc, consider skipping that step.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   536
<p>Faster CPUs, more RAM, and a faster DISK usually helps. The VM build tends to be CPU intensive (many C++ compiles), and the rest of the JDK will often be disk intensive.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   537
<p>Faster compiles are possible using a tool called <a href="http://ccache.samba.org/">ccache</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   538
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   539
<li><strong>File time issues:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   540
If you see warnings that refer to file time stamps, e.g.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   541
</ul>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   542
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   543
<p><em>Warning message:</em> <code>File 'xxx' has modification time in the future.</code><br />
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   544
<em>Warning message:</em> <code>Clock skew detected. Your build may be incomplete.</code></p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   545
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   546
<p>These warnings can occur when the clock on the build machine is out of sync with the timestamps on the source files. Other errors, apparently unrelated but in fact caused by the clock skew, can occur along with the clock skew warnings. These secondary errors may tend to obscure the fact that the true root cause of the problem is an out-of-sync clock.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   547
<p>If you see these warnings, reset the clock on the build machine, run &quot;<code>gmake clobber</code>&quot; or delete the directory containing the build output, and restart the build from the beginning.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   548
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   549
<li><strong>Error message: <code>Trouble writing out table to disk</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   550
Increase the amount of swap space on your build machine. This could be caused by overloading the system and it may be necessary to use:</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   551
</ul>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   552
<blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   553
<p><code>make JOBS=1</code></p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   554
</blockquote>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   555
<p>to reduce the load on the system.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   556
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   557
<li><p><strong>Error Message: <code>libstdc++ not found</code>:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   558
This is caused by a missing libstdc++.a library. This is installed as part of a specific package (e.g. libstdc++.so.devel.386). By default some 64-bit Linux versions (e.g. Fedora) only install the 64-bit version of the libstdc++ package. Various parts of the JDK build require a static link of the C++ runtime libraries to allow for maximum portability of the built images.</p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   559
<li><p><strong>Linux Error Message: <code>cannot restore segment prot after reloc</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   560
This is probably an issue with SELinux (See <a href="http://en.wikipedia.org/wiki/SELinux">SELinux on Wikipedia</a>). Parts of the VM is built without the <code>-fPIC</code> for performance reasons.</p></li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   561
</ul>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   562
<p>To completely disable SELinux:</p>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   563
<ol style="list-style-type: decimal">
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   564
<li><code>$ su root</code></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   565
<li><code># system-config-securitylevel</code></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   566
<li><code>In the window that appears, select the SELinux tab</code></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   567
<li><code>Disable SELinux</code></li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   568
</ol>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   569
<p>Alternatively, instead of completely disabling it you could disable just this one check.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   570
<ol style="list-style-type: decimal">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   571
<li>Select System-&gt;Administration-&gt;SELinux Management</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   572
<li>In the SELinux Management Tool which appears, select &quot;Boolean&quot; from the menu on the left</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   573
<li>Expand the &quot;Memory Protection&quot; group</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   574
<li>Check the first item, labeled &quot;Allow all unconfined executables to use libraries requiring text relocation ...&quot;</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   575
</ol>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   576
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   577
<li><strong>Windows Error Messages:</strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   578
<code>*** fatal error - couldn't allocate heap, ...</code><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   579
<code>rm fails with &quot;Directory not empty&quot;</code><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   580
<code>unzip fails with &quot;cannot create ... Permission denied&quot;</code><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   581
<code>unzip fails with &quot;cannot create ... Error 50&quot;</code></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   582
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   583
<p>The CYGWIN software can conflict with other non-CYGWIN software. See the CYGWIN FAQ section on <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda">BLODA (applications that interfere with CYGWIN)</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   584
<ul>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   585
<li><strong>Windows Error Message: <code>spawn failed</code></strong><br />
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   586
Try rebooting the system, or there could be some kind of issue with the disk or disk partition being used. Sometimes it comes with a &quot;Permission Denied&quot; message.</li>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   587
</ul>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   588
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   589
<h2 id="appendix-b-gnu-make">Appendix B: GNU make</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   590
<p>The Makefiles in the OpenJDK are only valid when used with the GNU version of the utility command <code>make</code> (usually called <code>gmake</code> on Solaris). A few notes about using GNU make:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   591
<ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   592
<li>You need GNU make version 3.81 or newer. On Windows 4.0 or newer is recommended. If the GNU make utility on your systems is not of a suitable version, see &quot;<a href="#buildgmake">Building GNU make</a>&quot;.</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   593
<li>Place the location of the GNU make binary in the <code>PATH</code>.</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   594
<li><strong>Solaris:</strong> Do NOT use <code>/usr/bin/make</code> on Solaris. If your Solaris system has the software from the Solaris Developer Companion CD installed, you should try and use <code>/usr/bin/gmake</code> or <code>/usr/gnu/bin/make</code>.</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   595
<li><strong>Windows:</strong> Make sure you start your build inside a bash shell.</li>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   596
<li><strong>Mac OS X:</strong> The XCode &quot;command line tools&quot; must be installed on your Mac.</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   597
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   598
<p>Information on GNU make, and access to ftp download sites, are available on the <a href="http://www.gnu.org/software/make/make.html">GNU make web site</a>. The latest source to GNU make is available at <a href="http://ftp.gnu.org/pub/gnu/make/">ftp.gnu.org/pub/gnu/make/</a>.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   599
<h3 id="building-gnu-make">Building GNU make</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   600
<p>First step is to get the GNU make 3.81 or newer source from <a href="http://ftp.gnu.org/pub/gnu/make/">ftp.gnu.org/pub/gnu/make/</a>. Building is a little different depending on the OS but is basically done with:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   601
<pre><code>  bash ./configure
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   602
  make</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   603
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   604
<h2 id="appendix-c-build-environments">Appendix C: Build Environments</h2>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   605
<h3 id="minimum-build-environments">Minimum Build Environments</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   606
<p>This file often describes specific requirements for what we call the &quot;minimum build environments&quot; (MBE) for this specific release of the JDK. What is listed below is what the Oracle Release Engineering Team will use to build the Oracle JDK product. Building with the MBE will hopefully generate the most compatible bits that install on, and run correctly on, the most variations of the same base OS and hardware architecture. In some cases, these represent what is often called the least common denominator, but each Operating System has different aspects to it.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   607
<p>In all cases, the Bootstrap JDK version minimum is critical, we cannot guarantee builds will work with older Bootstrap JDK's. Also in all cases, more RAM and more processors is better, the minimums listed below are simply recommendations.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   608
<p>With Solaris and Mac OS X, the version listed below is the oldest release we can guarantee builds and works, and the specific version of the compilers used could be critical.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   609
<p>With Windows the critical aspect is the Visual Studio compiler used, which due to it's runtime, generally dictates what Windows systems can do the builds and where the resulting bits can be used.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   610
<p><strong>NOTE: We expect a change here off these older Windows OS releases and to a 'less older' one, probably Windows 2008R2 X64.</strong></p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   611
<p>With Linux, it was just a matter of picking a stable distribution that is a good representative for Linux in general.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   612
<p>It is understood that most developers will NOT be using these specific versions, and in fact creating these specific versions may be difficult due to the age of some of this software. It is expected that developers are more often using the more recent releases and distributions of these operating systems.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   613
<p>Compilation problems with newer or different C/C++ compilers is a common problem. Similarly, compilation problems related to changes to the <code>/usr/include</code> or system header files is also a common problem with older, newer, or unreleased OS versions. Please report these types of problems as bugs so that they can be dealt with accordingly.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   614
<p>Bootstrap JDK: JDK 8</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   615
<table>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   616
<thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   617
<tr class="header">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   618
<th align="left">Base OS and Architecture</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   619
<th align="left">OS</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   620
<th align="left">C/C++ Compiler</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   621
<th align="left">Processors</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   622
<th align="left">RAM Minimum</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   623
<th align="left">DISK Needs</th>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   624
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   625
</thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   626
<tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   627
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   628
<td align="left">Linux X86 (32-bit) and X64 (64-bit)</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   629
<td align="left">Oracle Enterprise Linux 6.4</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   630
<td align="left">gcc 4.9.2</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   631
<td align="left">2 or more</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   632
<td align="left">1 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   633
<td align="left">6 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   634
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   635
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   636
<td align="left">Solaris SPARCV9 (64-bit)</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   637
<td align="left">Solaris 11 Update 1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   638
<td align="left">Studio 12 Update 4 + patches</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   639
<td align="left">4 or more</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   640
<td align="left">4 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   641
<td align="left">8 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   642
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   643
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   644
<td align="left">Solaris X64 (64-bit)</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   645
<td align="left">Solaris 11 Update 1</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   646
<td align="left">Studio 12 Update 4 + patches</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   647
<td align="left">4 or more</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   648
<td align="left">4 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   649
<td align="left">8 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   650
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   651
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   652
<td align="left">Windows X86 (32-bit)</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   653
<td align="left">Windows Server 2012 R2 x64</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   654
<td align="left">Microsoft Visual Studio C++ 2013 Professional Edition</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   655
<td align="left">2 or more</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   656
<td align="left">2 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   657
<td align="left">6 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   658
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   659
<tr class="odd">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   660
<td align="left">Windows X64 (64-bit)</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   661
<td align="left">Windows Server 2012 R2 x64</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   662
<td align="left">Microsoft Visual Studio C++ 2013 Professional Edition</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   663
<td align="left">2 or more</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   664
<td align="left">2 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   665
<td align="left">6 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   666
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   667
<tr class="even">
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   668
<td align="left">Mac OS X X64 (64-bit)</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   669
<td align="left">Mac OS X 10.9 &quot;Mavericks&quot;</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   670
<td align="left">Xcode 6.3 or newer</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   671
<td align="left">2 or more</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   672
<td align="left">4 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   673
<td align="left">6 GB</td>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   674
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   675
</tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   676
</table>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   677
<hr />
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   678
<h3 id="specific-developer-build-environments">Specific Developer Build Environments</h3>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   679
<p>We won't be listing all the possible environments, but we will try to provide what information we have available to us.</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   680
<p><strong>NOTE: The community can help out by updating this part of the document.</strong></p>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   681
<h4 id="fedora">Fedora</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   682
<p>After installing the latest <a href="http://fedoraproject.org">Fedora</a> you need to install several build dependencies. The simplest way to do it is to execute the following commands as user <code>root</code>:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   683
<pre><code>  yum-builddep java-1.7.0-openjdk
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   684
  yum install gcc gcc-c++</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   685
<p>In addition, it's necessary to set a few environment variables for the build:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   686
<pre><code>  export LANG=C
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   687
  export PATH=&quot;/usr/lib/jvm/java-openjdk/bin:${PATH}&quot;</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   688
<h4 id="centos-5.5">CentOS 5.5</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   689
<p>After installing <a href="http://www.centos.org/">CentOS 5.5</a> you need to make sure you have the following Development bundles installed:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   690
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   691
<li>Development Libraries</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   692
<li>Development Tools</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   693
<li>Java Development</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   694
<li>X Software Development (Including XFree86-devel)</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   695
</ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   696
<p>Plus the following packages:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   697
<ul>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   698
<li>cups devel: Cups Development Package</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   699
<li>alsa devel: Alsa Development Package</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   700
<li>Xi devel: libXi.so Development Package</li>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   701
</ul>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   702
<p>The freetype 2.3 packages don't seem to be available, but the freetype 2.3 sources can be downloaded, built, and installed easily enough from <a href="http://downloads.sourceforge.net/freetype">the freetype site</a>. Build and install with something like:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   703
<pre><code>  bash ./configure
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   704
  make
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   705
  sudo -u root make install</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   706
<p>Mercurial packages could not be found easily, but a Google search should find ones, and they usually include Python if it's needed.</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   707
<h4 id="debian-5.0-lenny">Debian 5.0 (Lenny)</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   708
<p>After installing <a href="http://debian.org">Debian</a> 5 you need to install several build dependencies. The simplest way to install the build dependencies is to execute the following commands as user <code>root</code>:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   709
<pre><code>  aptitude build-dep openjdk-7
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   710
  aptitude install openjdk-7-jdk libmotif-dev</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   711
<p>In addition, it's necessary to set a few environment variables for the build:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   712
<pre><code>  export LANG=C
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   713
  export PATH=&quot;/usr/lib/jvm/java-7-openjdk/bin:${PATH}&quot;</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   714
<h4 id="ubuntu-12.04">Ubuntu 12.04</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   715
<p>After installing <a href="http://ubuntu.org">Ubuntu</a> 12.04 you need to install several build dependencies. The simplest way to do it is to execute the following commands:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   716
<pre><code>  sudo aptitude build-dep openjdk-7
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   717
  sudo aptitude install openjdk-7-jdk</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   718
<p>In addition, it's necessary to set a few environment variables for the build:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   719
<pre><code>  export LANG=C
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   720
  export PATH=&quot;/usr/lib/jvm/java-7-openjdk/bin:${PATH}&quot;</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   721
<h4 id="opensuse-11.1">OpenSUSE 11.1</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   722
<p>After installing <a href="http://opensuse.org">OpenSUSE</a> 11.1 you need to install several build dependencies. The simplest way to install the build dependencies is to execute the following commands:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   723
<pre><code>  sudo zypper source-install -d java-1_7_0-openjdk
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   724
  sudo zypper install make</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   725
<p>In addition, it is necessary to set a few environment variables for the build:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   726
<pre><code>  export LANG=C
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   727
  export PATH=&quot;/usr/lib/jvm/java-1.7.0-openjdk/bin:$[PATH}&quot;</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   728
<p>Finally, you need to unset the <code>JAVA_HOME</code> environment variable:</p>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   729
<pre><code>  export -n JAVA_HOME`</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   730
<h4 id="mandriva-linux-one-2009-spring">Mandriva Linux One 2009 Spring</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   731
<p>After installing <a href="http://mandriva.org">Mandriva</a> Linux One 2009 Spring you need to install several build dependencies. The simplest way to install the build dependencies is to execute the following commands as user <code>root</code>:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   732
<pre><code>  urpmi java-1.7.0-openjdk-devel make gcc gcc-c++ freetype-devel zip unzip
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   733
    libcups2-devel libxrender1-devel libalsa2-devel libstc++-static-devel
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   734
    libxtst6-devel libxi-devel</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   735
<p>In addition, it is necessary to set a few environment variables for the build:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   736
<pre><code>  export LANG=C
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   737
  export PATH=&quot;/usr/lib/jvm/java-1.7.0-openjdk/bin:${PATH}&quot;</code></pre>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   738
<h4 id="opensolaris-2009.06">OpenSolaris 2009.06</h4>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   739
<p>After installing <a href="http://opensolaris.org">OpenSolaris</a> 2009.06 you need to install several build dependencies. The simplest way to install the build dependencies is to execute the following commands:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   740
<pre><code>  pfexec pkg install SUNWgmake SUNWj7dev sunstudioexpress SUNWcups SUNWzip
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   741
    SUNWunzip SUNWxwhl SUNWxorg-headers SUNWaudh SUNWfreetype2</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   742
<p>In addition, it is necessary to set a few environment variables for the build:</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   743
<pre><code>  export LANG=C
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   744
  export PATH=&quot;/opt/SunStudioExpress/bin:${PATH}&quot;</code></pre>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   745
<hr />
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   746
<p>End of the OpenJDK build README document.</p>
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   747
<p>Please come again!</p>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   748
</body>
333
d4540117530e 6563616: Clarify instructions for unpacking openjdk binary "plug"
ohair
parents: 15
diff changeset
   749
</html>