You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -112,10 +110,10 @@ <h1 class="title">Building the JDK</h1>
112
110
</ul>
113
111
</nav>
114
112
<h2id="tldr-instructions-for-the-impatient">TL;DR (Instructions for the Impatient)</h2>
115
-
<p>If you are eager to try out building the JDK, these simple steps works most of the time. They assume that you have installed Mercurial (and Cygwin if running on Windows) and cloned the top-level JDK repository that you want to build.</p>
113
+
<p>If you are eager to try out building the JDK, these simple steps works most of the time. They assume that you have installed Git (and Cygwin if running on Windows) and cloned the top-level JDK repository that you want to build.</p>
116
114
<oltype="1">
117
115
<li><p><ahref="#getting-the-source-code">Get the complete source code</a>:<br/>
<p>If <code>configure</code> fails due to missing dependencies (to either the <ahref="#native-compiler-toolchain-requirements">toolchain</a>, <ahref="#build-tools-requirements">build tools</a>, <ahref="#external-library-requirements">external libraries</a> or the <ahref="#boot-jdk-requirements">boot JDK</a>), most of the time it prints a suggestion on how to resolve the situation on your platform. Follow the instructions, and try running <code>bash configure</code> again.</p></li>
<p>The JDK is a complex software project. Building it requires a certain amount of technical expertise, a fair number of dependencies on external software, and reasonably powerful hardware.</p>
132
130
<p>If you just want to use the JDK and not build it yourself, this document is not for you. See for instance <ahref="http://openjdk.java.net/install">OpenJDK installation</a> for some methods of installing a prebuilt JDK.</p>
133
131
<h2id="getting-the-source-code">Getting the Source Code</h2>
134
-
<p>Make sure you are getting the correct version. As of JDK 10, the source is no longer split into separate repositories so you only need to clone one single repository. At the <ahref="http://hg.openjdk.java.net/">OpenJDK Mercurial server</a> you can see a list of all available forests. If you want to build an older version, e.g. JDK 8, it is recommended that you get the <code>jdk8u</code> forest, which contains incremental updates, instead of the <code>jdk8</code> forest, which was frozen at JDK 8 GA.</p>
135
-
<p>If you are new to Mercurial, a good place to start is the <ahref="http://www.mercurial-scm.org/guide">Mercurial Beginner's Guide</a>. The rest of this document assumes a working knowledge of Mercurial.</p>
132
+
<p>Make sure you are getting the correct version. As of JDK 10, the source is no longer split into separate repositories so you only need to clone one single repository. At the <ahref="https://git.openjdk.java.net/">OpenJDK Git site</a> you can see a list of all available repositories. If you want to build an older version, e.g. JDK 8, it is recommended that you get the <code>jdk8u</code> forest, which contains incremental updates, instead of the <code>jdk8</code> forest, which was frozen at JDK 8 GA.</p>
133
+
<p>If you are new to Git, a good place to start is the book <ahref="https://git-scm.com/book/en/v2">Pro Git</a>. The rest of this document assumes a working knowledge of Git.</p>
<li><p>Create the directory that is going to contain the top directory of the JDK clone by using the <code>mkdir</code> command in the Cygwin bash shell. That is, do <em>not</em> create it using Windows Explorer. This will ensure that it will have proper Cygwin attributes, and that it's children will inherit those attributes.</p></li>
145
143
<li><p>Do not put the JDK clone in a path under your Cygwin home directory. This is especially important if your user name contains spaces and/or mixed upper and lower case letters.</p></li>
146
-
<li><p>Clone the JDK repository using the Cygwin command line <code>hg</code> client as instructed in this document. That is, do <em>not</em> use another Mercurial client such as TortoiseHg.</p></li>
144
+
<li><p>You need to install a git client. You have two choices, Cygwin git or Git for Windows. Unfortunately there are pros and cons with each choice.</p>
145
+
<ul>
146
+
<li><p>The Cygwin <code>git</code> client has no line ending issues and understands Cygwin paths (which are used throughout the JDK build system). However, it does not currently work well with the Skara CLI tooling. Please see the <ahref="https://wiki.openjdk.java.net/display/SKARA/Skara#Skara-Git">Skara wiki on Git clients</a> for up-to-date information about the Skara git client support.</p></li>
147
+
<li><p>The <ahref="https://gitforwindows.org">Git for Windows</a> client has issues with line endings, and do not understand Cygwin paths. It does work well with the Skara CLI tooling, however. To alleviate the line ending problems, make sure you set <code>core.autocrlf</code> to <code>false</code> (this is asked during installation).</p></li>
148
+
</ul></li>
147
149
</ul>
148
150
<p>Failure to follow this procedure might result in hard-to-debug build problems.</p></li>
149
151
</ul>
@@ -193,7 +195,7 @@ <h3 id="windows">Windows</h3>
193
195
<p>Windows XP is not a supported platform, but all newer Windows should be able to build the JDK.</p>
194
196
<p>On Windows, it is important that you pay attention to the instructions in the <ahref="#special-considerations">Special Considerations</a>.</p>
195
197
<p>Windows is the only non-POSIX OS supported by the JDK, and as such, requires some extra care. A POSIX support layer is required to build on Windows. Currently, the only supported such layer is Cygwin. (Msys is no longer supported due to a too old bash; msys2 and the new Windows Subsystem for Linux (WSL) would likely be possible to support in a future version but that would require effort to implement.)</p>
196
-
<p>Internally in the build system, all paths are represented as Unix-style paths, e.g. <code>/cygdrive/c/hg/jdk9/Makefile</code> rather than <code>C:\hg\jdk9\Makefile</code>. This rule also applies to input to the build system, e.g. in arguments to <code>configure</code>. So, use <code>--with-msvcr-dll=/cygdrive/c/msvcr100.dll</code> rather than <code>--with-msvcr-dll=c:\msvcr100.dll</code>. For details on this conversion, see the section on <ahref="#fixpath">Fixpath</a>.</p>
198
+
<p>Internally in the build system, all paths are represented as Unix-style paths, e.g. <code>/cygdrive/c/git/jdk/Makefile</code> rather than <code>C:\git\jdk\Makefile</code>. This rule also applies to input to the build system, e.g. in arguments to <code>configure</code>. So, use <code>--with-msvcr-dll=/cygdrive/c/msvcr100.dll</code> rather than <code>--with-msvcr-dll=c:\msvcr100.dll</code>. For details on this conversion, see the section on <ahref="#fixpath">Fixpath</a>.</p>
197
199
<h4id="cygwin">Cygwin</h4>
198
200
<p>A functioning <ahref="http://www.cygwin.com/">Cygwin</a> environment is thus required for building the JDK on Windows. If you have a 64-bit OS, we strongly recommend using the 64-bit version of Cygwin.</p>
199
201
<p><strong>Note:</strong> Cygwin has a model of continuously updating all packages without any easy way to install or revert to a specific version of a package. This means that whenever you add or update a package in Cygwin, you might (inadvertently) update tools that are used by the JDK build process, and that can cause unexpected build problems.</p>
@@ -577,27 +579,27 @@ <h3 id="cross-compiling-the-easy-way-with-openjdk-devkits">Cross compiling the e
=== Output from failing command(s) repeated here ===
791
793
* For target hotspot_variant-server_libjvm_objs_psMemoryPool.o:
792
-
/localhome/hg/jdk9-sandbox/hotspot/src/share/vm/services/psMemoryPool.cpp:1:1: error: 'failhere' does not name a type
794
+
/localhome/git/jdk-sandbox/hotspot/src/share/vm/services/psMemoryPool.cpp:1:1: error: 'failhere' does not name a type
793
795
... (rest of output omitted)
794
796
795
-
* All command lines available in /localhome/hg/jdk9-sandbox/build/linux-x64/make-support/failure-logs.
797
+
* All command lines available in /localhome/git/jdk-sandbox/build/linux-x64/make-support/failure-logs.
796
798
=== End of repeated output ===
797
799
798
800
=== Make failed targets repeated here ===
799
-
lib/CompileJvm.gmk:207: recipe for target '/localhome/hg/jdk9-sandbox/build/linux-x64/hotspot/variant-server/libjvm/objs/psMemoryPool.o' failed
801
+
lib/CompileJvm.gmk:207: recipe for target '/localhome/git/jdk-sandbox/build/linux-x64/hotspot/variant-server/libjvm/objs/psMemoryPool.o' failed
800
802
make/Main.gmk:263: recipe for target 'hotspot-server-libs' failed
801
803
=== End of repeated output ===
802
804
@@ -819,11 +821,11 @@ <h4 id="problems-with-the-build-environment">Problems with the Build Environment
819
821
<p>Verify that the summary at the end looks correct. Are you indeed using the Boot JDK and native toolchain that you expect?</p>
820
822
<p>By default, the JDK has a strict approach where warnings from the compiler is considered errors which fail the build. For very new or very old compiler versions, this can trigger new classes of warnings, which thus fails the build. Run <code>configure</code> with <code>--disable-warnings-as-errors</code> to turn of this behavior. (The warnings will still show, but not make the build fail.)</p>
821
823
<h4id="problems-with-incremental-rebuilds">Problems with Incremental Rebuilds</h4>
822
-
<p>Incremental rebuilds mean that when you modify part of the product, only the affected parts get rebuilt. While this works great in most cases, and significantly speed up the development process, from time to time complex interdependencies will result in an incorrect build result. This is the most common cause for unexpected build problems, together with inconsistencies between the different Mercurial repositories in the forest.</p>
824
+
<p>Incremental rebuilds mean that when you modify part of the product, only the affected parts get rebuilt. While this works great in most cases, and significantly speed up the development process, from time to time complex interdependencies will result in an incorrect build result. This is the most common cause for unexpected build problems.</p>
823
825
<p>Here are a suggested list of things to try if you are having unexpected build problems. Each step requires more time than the one before, so try them in order. Most issues will be solved at step 1 or 2.</p>
824
826
<oltype="1">
825
-
<li><p>Make sure your forest is up-to-date</p>
826
-
<p>Run <code>bash get_source.sh</code> to make sure you have the latest version of all repositories.</p></li>
827
+
<li><p>Make sure your repository is up-to-date</p>
828
+
<p>Run <code>git pull origin master</code> to make sure you have the latest changes.</p></li>
827
829
<li><p>Clean build results</p>
828
830
<p>The simplest way to fix incremental rebuild issues is to run <code>make clean</code>. This will remove all build results, but not the configuration or any build system support artifacts. In most cases, this will solve build errors resulting from incremental build mismatches.</p></li>
829
831
<li><p>Completely clean the build directory.</p>
@@ -832,8 +834,8 @@ <h4 id="problems-with-incremental-rebuilds">Problems with Incremental Rebuilds</
832
834
make dist-clean
833
835
bash configure $(cat current-configuration)
834
836
make</code></pre></li>
835
-
<li><p>Re-clone the Mercurial forest</p>
836
-
<p>Sometimes the Mercurial repositories themselves gets in a state that causes the product to be un-buildable. In such a case, the simplest solution is often the "sledgehammer approach": delete the entire forest, and re-clone it. If you have local changes, save them first to a different location using <code>hg export</code>.</p></li>
837
+
<li><p>Re-clone the Git repository</p>
838
+
<p>Sometimes the Git repository gets in a state that causes the product to be un-buildable. In such a case, the simplest solution is often the "sledgehammer approach": delete the entire repository, and re-clone it. If you have local changes, save them first to a different location using <code>git format-patch</code>.</p></li>
@@ -852,28 +854,9 @@ <h4 id="out-of-memory-errors">Out of Memory Errors</h4>
852
854
spawn failed</code></pre>
853
855
<p>This can be a sign of a Cygwin problem. See the information about solving problems in the <ahref="#cygwin">Cygwin</a> section. Rebooting the computer might help temporarily.</p>
854
856
<h3id="getting-help">Getting Help</h3>
855
-
<p>If none of the suggestions in this document helps you, or if you find what you believe is a bug in the build system, please contact the Build Group by sending a mail to <scripttype="text/javascript">
</script><noscript>build-dev at openjdk dot java dot net</noscript>. Please include the relevant parts of the configure and/or build log.</p>
857
+
<p>If none of the suggestions in this document helps you, or if you find what you believe is a bug in the build system, please contact the Build Group by sending a mail to <ahref="mailto:build-dev@openjdk.java.net">build-dev@openjdk.java.net</a>. Please include the relevant parts of the configure and/or build log.</p>
861
858
<p>If you need general help or advice about developing for the JDK, you can also contact the Adoption Group. See the section on <ahref="#contributing-to-openjdk">Contributing to OpenJDK</a> for more information.</p>
862
859
<h2id="hints-and-suggestions-for-advanced-users">Hints and Suggestions for Advanced Users</h2>
863
-
<h3id="setting-up-a-forest-for-pushing-changes-defpath">Setting Up a Forest for Pushing Changes (defpath)</h3>
864
-
<p>To help you prepare a proper push path for a Mercurial repository, there exists a useful tool known as <ahref="http://openjdk.java.net/projects/code-tools/defpath">defpath</a>. It will help you setup a proper push path for pushing changes to the JDK.</p>
865
-
<p>Install the extension by cloning <code>http://hg.openjdk.java.net/code-tools/defpath</code> and updating your <code>.hgrc</code> file. Here's one way to do this:</p>
<p>If you also have the <code>trees</code> extension installed in Mercurial, you will automatically get a <code>tdefpath</code> command, which is even more useful. By running <code>hg tdefpath -du <username></code> in the top repository of your forest, all repos will get setup automatically. This is the recommended usage.</p>
877
860
<h3id="bash-completion">Bash Completion</h3>
878
861
<p>The <code>configure</code> and <code>make</code> commands tries to play nice with bash command-line completion (using <code><tab></code> or <code><tab><tab></code>). To use this functionality, make sure you enable completion in your <code>~/.bashrc</code> (see instructions for bash in your operating system).</p>
879
862
<p>Make completion will work out of the box, and will complete valid make targets. For instance, typing <code>make jdk-i<tab></code> will complete to <code>make jdk-image</code>.</p>
@@ -927,14 +910,6 @@ <h4 id="skipping-the-dependency-check">Skipping the Dependency Check</h4>
927
910
<h4id="rebuilding-part-of-java.base-jdk_filter">Rebuilding Part of java.base (JDK_FILTER)</h4>
928
911
<p>If you are modifying files in <code>java.base</code>, which is the by far largest module in the JDK, then you need to rebuild all those files whenever a single file has changed. (This inefficiency will hopefully be addressed in JDK 10.)</p>
929
912
<p>As a hack, you can use the make control variable <code>JDK_FILTER</code> to specify a pattern that will be used to limit the set of files being recompiled. For instance, <code>make java.base JDK_FILTER=javax/crypto</code> (or, to combine methods, <code>make java.base-java-only JDK_FILTER=javax/crypto</code>) will limit the compilation to files in the <code>javax.crypto</code> package.</p>
930
-
<h3id="learn-about-mercurial">Learn About Mercurial</h3>
931
-
<p>To become an efficient JDK developer, it is recommended that you invest in learning Mercurial properly. Here are some links that can get you started:</p>
932
-
<ul>
933
-
<li><ahref="http://www.mercurial-scm.org/wiki/GitConcepts">Mercurial for git users</a></li>
934
-
<li><ahref="http://www.mercurial-scm.org/wiki/Tutorial">The official Mercurial tutorial</a></li>
935
-
<li><ahref="http://hginit.com/">hg init</a></li>
936
-
<li><ahref="http://hgbook.red-bean.com/read/">Mercurial: The Definitive Guide</a></li>
937
-
</ul>
938
913
<h2id="understanding-the-build-system">Understanding the Build System</h2>
939
914
<p>This section will give you a more technical description on the details of the build system.</p>
1 commit comments
openjdk-notifier[bot] commentedon Aug 23, 2021
Review
Issues