stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8191715: Update documentation pointing to "common" directory

Browse Source 
Reviewed-by: erikj
This commit is contained in:
Magnus Ihse Bursie 2017-11-23 13:24:40 +01:00
parent 802a8bcaf3
commit 7e43455ead
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/building.html
View File

@ -871,9 +871,9 @@ test-support/</code></pre>
<p>When building for distribution, <code>zipped</code> is a good solution. Binaries built with <code>internal</code> is suitable for use by developers, since they facilitate debugging, but should be stripped before distributed to end users.</p> <p>When building for distribution, <code>zipped</code> is a good solution. Binaries built with <code>internal</code> is suitable for use by developers, since they facilitate debugging, but should be stripped before distributed to end users.</p>
<h3 id="autoconf-details">Autoconf Details</h3> <h3 id="autoconf-details">Autoconf Details</h3>
<p>The <code>configure</code> script is based on the autoconf framework, but in some details deviate from a normal autoconf <code>configure</code> script.</p> <p>The <code>configure</code> script is based on the autoconf framework, but in some details deviate from a normal autoconf <code>configure</code> script.</p>
<p>The <code>configure</code> script in the top level directory of OpenJDK is just a thin wrapper that calls <code>common/autoconf/configure</code>. This in turn provides functionality that is not easily expressed in the normal Autoconf framework, and then calls into the core of the <code>configure</code> script, which is the <code>common/autoconf/generated-configure.sh</code> file.</p> <p>The <code>configure</code> script in the top level directory of OpenJDK is just a thin wrapper that calls <code>make/autoconf/configure</code>. This in turn provides functionality that is not easily expressed in the normal Autoconf framework, and then calls into the core of the <code>configure</code> script, which is the <code>make/autoconf/generated-configure.sh</code> file.</p>
<p>As the name implies, this file is generated by Autoconf. It is checked in after regeneration, to alleviate the common user to have to install Autoconf.</p> <p>As the name implies, this file is generated by Autoconf. It is checked in after regeneration, to alleviate the common user to have to install Autoconf.</p>
<p>The build system will detect if the Autoconf source files have changed, and will trigger a regeneration of <code>common/autoconf/generated-configure.sh</code> if needed. You can also manually request such an update by <code>bash common/autoconf/autogen.sh</code>.</p> <p>The build system will detect if the Autoconf source files have changed, and will trigger a regeneration of <code>make/autoconf/generated-configure.sh</code> if needed. You can also manually request such an update by <code>bash make/autoconf/autogen.sh</code>.</p>
<p>If you make changes to the build system that requires a re-generation, note the following:</p> <p>If you make changes to the build system that requires a re-generation, note the following:</p>
<ul> <ul>
<li><p>You must use <em>exactly</em> version 2.69 of autoconf for your patch to be accepted. This is to avoid spurious changes in the generated file. Note that Ubuntu 16.04 ships a patched version of autoconf which claims to be 2.69, but is not.</p></li> <li><p>You must use <em>exactly</em> version 2.69 of autoconf for your patch to be accepted. This is to avoid spurious changes in the generated file. Note that Ubuntu 16.04 ships a patched version of autoconf which claims to be 2.69, but is not.</p></li>

8
doc/building.md
View File

@ -1660,18 +1660,18 @@ The `configure` script is based on the autoconf framework, but in some details
deviate from a normal autoconf `configure` script. deviate from a normal autoconf `configure` script.
The `configure` script in the top level directory of OpenJDK is just a thin The `configure` script in the top level directory of OpenJDK is just a thin
wrapper that calls `common/autoconf/configure`. This in turn provides wrapper that calls `make/autoconf/configure`. This in turn provides
functionality that is not easily expressed in the normal Autoconf framework, functionality that is not easily expressed in the normal Autoconf framework,
and then calls into the core of the `configure` script, which is the and then calls into the core of the `configure` script, which is the
`common/autoconf/generated-configure.sh` file. `make/autoconf/generated-configure.sh` file.
As the name implies, this file is generated by Autoconf. It is checked in after As the name implies, this file is generated by Autoconf. It is checked in after
regeneration, to alleviate the common user to have to install Autoconf. regeneration, to alleviate the common user to have to install Autoconf.
The build system will detect if the Autoconf source files have changed, and The build system will detect if the Autoconf source files have changed, and
will trigger a regeneration of `common/autoconf/generated-configure.sh` if will trigger a regeneration of `make/autoconf/generated-configure.sh` if
needed. You can also manually request such an update by `bash needed. You can also manually request such an update by `bash
common/autoconf/autogen.sh`. make/autoconf/autogen.sh`.
If you make changes to the build system that requires a re-generation, note the If you make changes to the build system that requires a re-generation, note the
following: following:

2
make/Init.gmk
View File

@ -329,7 +329,7 @@ else # HAS_SPEC=true
$(call PrintFailureReports) $(call PrintFailureReports)
$(call PrintBuildLogFailures) $(call PrintBuildLogFailures)
$(call ReportProfileTimes) $(call ReportProfileTimes)
$(PRINTF) "Hint: See common/doc/building.html#troubleshooting for assistance.\n\n" $(PRINTF) "Hint: See doc/building.html#troubleshooting for assistance.\n\n"
ifneq ($(COMPARE_BUILD), ) ifneq ($(COMPARE_BUILD), )
$(call CleanupCompareBuild) $(call CleanupCompareBuild)
endif endif

4
make/RunTests.gmk
View File

@ -162,7 +162,7 @@ endef
ifeq ($(TEST), ) ifeq ($(TEST), )
$(info No test selection given in TEST!) $(info No test selection given in TEST!)
$(info Please use e.g. 'run-test TEST=tier1' or 'run-test-tier1') $(info Please use e.g. 'run-test TEST=tier1' or 'run-test-tier1')
$(info See common/doc/testing.[md|html] for help) $(info See doc/testing.[md|html] for help)
$(error Cannot continue) $(error Cannot continue)
endif endif
@ -185,7 +185,7 @@ $(foreach test, $(TEST), \
ifneq ($(UNKNOWN_TEST), ) ifneq ($(UNKNOWN_TEST), )
$(info Unknown test selection: '$(UNKNOWN_TEST)') $(info Unknown test selection: '$(UNKNOWN_TEST)')
$(info See common/doc/testing.[md|html] for help) $(info See doc/testing.[md|html] for help)
$(error Cannot continue) $(error Cannot continue)
endif endif

10
make/conf/jib-profiles.js
View File

@ -203,7 +203,7 @@ var getJibProfiles = function (input) {
data.src_bundle_excludes = "./build webrev* */webrev* */*/webrev* */*/*/webrev* .hg */.hg */*/.hg */*/*/.hg"; data.src_bundle_excludes = "./build webrev* */webrev* */*/webrev* */*/*/webrev* .hg */.hg */*/.hg */*/*/.hg";
// Include list to use when creating a minimal jib source bundle which // Include list to use when creating a minimal jib source bundle which
// contains just the jib configuration files. // contains just the jib configuration files.
data.conf_bundle_includes = "*/conf/jib-profiles.* common/autoconf/version-numbers" data.conf_bundle_includes = "*/conf/jib-profiles.* make/autoconf/version-numbers"
// Define some common values // Define some common values
var common = getJibProfilesCommon(input, data); var common = getJibProfilesCommon(input, data);
@ -1043,7 +1043,7 @@ var concatObjects = function (o1, o2) {
/** /**
* Constructs the numeric version string from reading the * Constructs the numeric version string from reading the
* common/autoconf/version-numbers file and removing all trailing ".0". * make/autoconf/version-numbers file and removing all trailing ".0".
* *
* @param major Override major version * @param major Override major version
* @param minor Override minor version * @param minor Override minor version
@ -1080,17 +1080,17 @@ var versionArgs = function(input, common) {
return args; return args;
} }
// Properties representation of the common/autoconf/version-numbers file. Lazily // Properties representation of the make/autoconf/version-numbers file. Lazily
// initiated by the function below. // initiated by the function below.
var version_numbers; var version_numbers;
/** /**
* Read the common/autoconf/version-numbers file into a Properties object. * Read the make/autoconf/version-numbers file into a Properties object.
* *
* @returns {java.utilProperties} * @returns {java.utilProperties}
*/ */
var getVersionNumbers = function () { var getVersionNumbers = function () {
// Read version information from common/autoconf/version-numbers // Read version information from make/autoconf/version-numbers
if (version_numbers == null) { if (version_numbers == null) {
version_numbers = new java.util.Properties(); version_numbers = new java.util.Properties();
var stream = new java.io.FileInputStream(__DIR__ + "/../autoconf/version-numbers"); var stream = new java.io.FileInputStream(__DIR__ + "/../autoconf/version-numbers");