Blame - README-builds.html - platform/libcore

2007-12-01 00:00:00 +0000

[diff] [blame]

1

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

2

<html>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

3

<head>

4

<title>OpenJDK Build README</title>

5

</head>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

6

7

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

8

Kelly O'Hair

2008-09-17 13:30:32 -0700

[diff] [blame]

9

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

10

<tr>

11

Kelly O'Hair

634c79b

2008-07-09 15:42:00 -0700

[diff] [blame]

12

<img alt="OpenJDK"

13

src="http://openjdk.java.net/images/openjdk.png"

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

14

width=256>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

</td>

</tr>

<tr>

<h1>OpenJDK Build README</h1>

20

</td>

21

</tr>

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

22

</table>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

23

24

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

25

<hr>

26

<h2><a name="introduction">Introduction</a></h2>

27

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

28

This README file contains build instructions for the

29

<a href="http://openjdk.java.net" target="_blank">OpenJDK</a>.

30

Building the source code for the

31

OpenJDK

32

requires

33

a certain degree of technical expertise.

34

35

36

<h3>!!!!!!!!!!!!!!! THIS IS A MAJOR RE-WRITE of this document. !!!!!!!!!!!!!</h3>

Some Headlines:

<ul>

<li>

The build is now a "<code>configure && make</code>" style build

42

</li>

43

<li>

Erik Joelsson

6e76eef

2015-04-17 10:43:28 +0200

[diff] [blame]

44

Any GNU make 3.81 or newer should work, except on

45

Windows where 4.0 or newer is recommended.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

46

</li>

47

<li>

48

The build should scale, i.e. more processors should

49

cause the build to be done in less wall-clock time

50

</li>

51

<li>

52

Nested or recursive make invocations have been significantly

53

reduced, as has the total fork/exec or spawning

54

of sub processes during the build

55

</li>

56

<li>

57

Windows MKS usage is no longer supported

58

</li>

59

<li>

60

Windows Visual Studio <code>vsvars*.bat</code> and

61

<code>vcvars*.bat</code> files are run automatically

62

</li>

63

<li>

64

Ant is no longer used when building the OpenJDK

65

</li>

66

<li>

67

Use of ALT_* environment variables for configuring the

68

build is no longer supported

69

</li>

70

</ul>

71

</blockquote>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

72

</blockquote>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

73

74

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

75

<hr>

76

<h2><a name="contents">Contents</a></h2>

77

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

78

<ul>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

79

<li><a href="#introduction">Introduction</a></li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

80

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

81

<li><a href="#hg">Use of Mercurial</a>

82

<ul>

83

<li><a href="#get_source">Getting the Source</a></li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

84

<li><a href="#repositories">Repositories</a></li>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

85

</ul>

86

</li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

87

88

<li><a href="#building">Building</a>

Kelly O'Hair

2008-09-17 13:30:32 -0700

[diff] [blame]

89

<ul>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

90

<li><a href="#setup">System Setup</a>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

91

<ul>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

92

<li><a href="#linux">Linux</a></li>

93

<li><a href="#solaris">Solaris</a></li>

94

95

<li><a href="#windows">Windows</a></li>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

96

</ul>

97

</li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

98

<li><a href="#configure">Configure</a></li>

99

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

100

</ul>

101

</li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

102

<li><a href="#testing">Testing</a></li>

</ul>

<hr>

<ul>

<li><a href="#hints">Appendix A: Hints and Tips</a>

107

<ul>

108

109

<li><a href="#performance">Build Performance Tips</a></li>

110

<li><a href="#troubleshooting">Troubleshooting</a></li>

111

</ul>

112

</li>

113

<li><a href="#gmake">Appendix B: GNU Make Information</a></li>

114

<li><a href="#buildenvironments">Appendix C: Build Environments</a></li>

115

116

<!-- Leave out

117

<li><a href="#mapping">Appendix D: Mapping Old Builds to the New Builds</a></li>

118

-->

119

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

120

</ul>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

121

</blockquote>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

122

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

123

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

124

<hr>

125

<h2><a name="hg">Use of Mercurial</a></h2>

126

127

The OpenJDK sources are maintained with the revision control system

128

<a href="http://mercurial.selenic.com/wiki/Mercurial">Mercurial</a>.

129

If you are new to Mercurial, please see the

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

130

131

Beginner Guides</a>

132

or refer to the <a href="http://hgbook.red-bean.com/">

133

Mercurial Book</a>.

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

134

The first few chapters of the book provide an excellent overview of

135

Mercurial, what it is and how it works.

136

<br>

137

For using Mercurial with the OpenJDK refer to the

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

138

139

Developer Guide: Installing and Configuring Mercurial</a>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

140

section for more information.

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

141

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

142

<h3><a name="get_source">Getting the Source</a></h3>

143

144

To get the entire set of OpenJDK Mercurial repositories

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

145

use the script <code>get_source.sh</code> located in the

146

root repository:

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

147

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

148

<code>

Erik Joelsson

2014-04-24 10:21:58 +0200

[diff] [blame]

149

hg clone http://hg.openjdk.java.net/jdk9/jdk9

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

150

<i>YourOpenJDK</i>

151

<br>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

152

cd <i>YourOpenJDK</i>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

<br>

bash ./get_source.sh

</code>

</blockquote>

Once you have all the repositories, keep in mind that each

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

158

repository is its own independent repository.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

159

You can also re-run <code>./get_source.sh</code> anytime to

160

pull over all the latest changesets in all the repositories.

161

This set of nested repositories has been given the term

162

"forest" and there are various ways to apply the same

163

<code>hg</code> command to each of the repositories.

164

For example, the script <code>make/scripts/hgforest.sh</code>

165

can be used to repeat the same <code>hg</code>

166

command on every repository, e.g.

167

168

<code>

169

cd <i>YourOpenJDK</i>

170

<br>

171

bash ./make/scripts/hgforest.sh status

172

</code>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

173

</blockquote>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

174

</blockquote>

175

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

176

<h3><a name="repositories">Repositories</a></h3>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

177

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

178

<p>The set of repositories and what they contain:</p>

<thead>

<tr>

<th>Repository</th>

<th>Contains</th>

</tr>

</thead>

<tbody>

<tr>

<td>

. (root)

</td>

<td>

common configure and makefile logic

</td>

</tr>

<tr>

<td>

hotspot

</td>

<td>

source code and make files for building

201

the OpenJDK Hotspot Virtual Machine

</td>

</tr>

<tr>

<td>

langtools

</td>

<td>

source code for the OpenJDK javac and language tools

</td>

</tr>

<tr>

<td>

jdk

</td>

<td>

source code and make files for building

218

the OpenJDK runtime libraries and misc files

</td>

</tr>

<tr>

<td>

jaxp

</td>

<td>

source code for the OpenJDK JAXP functionality

</td>

</tr>

<tr>

<td>

jaxws

</td>

<td>

source code for the OpenJDK JAX-WS functionality

</td>

</tr>

<tr>

<td>

corba

</td>

<td>

source code for the OpenJDK Corba functionality

243

</td>

244

</tr>

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

<tr>

<td>

nashorn

</td>

<td>

source code for the OpenJDK JavaScript implementation

251

</td>

252

</tr>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

253

</tbody>

254

</table>

Kelly O'Hair

2008-09-17 13:30:32 -0700

[diff] [blame]

255

</blockquote>

Dalibor Topic

73e9e34

2009-09-23 20:06:01 +0200

[diff] [blame]

256

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

257

<h3><a name="guidelines">Repository Source Guidelines</a></h3>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

258

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

259

There are some very basic guidelines:

Kelly O'Hair

2008-09-17 13:30:32 -0700

[diff] [blame]

260

<ul>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

261

<li>

262

Use of whitespace in source files

263

(.java, .c, .h, .cpp, and .hpp files)

264

is restricted.

265

No TABs, no trailing whitespace on lines, and files

266

should not terminate in more than one blank line.

267

</li>

268

<li>

269

Files with execute permissions should not be added

270

to the source repositories.

271

</li>

272

<li>

273

All generated files need to be kept isolated from

274

the files

275

maintained or managed by the source control system.

276

The standard area for generated files is the top level

277

<code>build/</code> directory.

278

</li>

279

<li>

280

The default build process should be to build the product

281

and nothing else, in one form, e.g. a product (optimized),

282

debug (non-optimized, -g plus assert logic), or

283

fastdebug (optimized, -g plus assert logic).

284

</li>

285

<li>

286

The <tt>.hgignore</tt> file in each repository

287

must exist and should

288

include <tt>^build/</tt>, <tt>^dist/</tt> and

289

optionally any

290

<tt>nbproject/private</tt> directories.

291

<strong>It should NEVER</strong> include

292

anything in the

293

294

or any managed directory area of a repository.

295

</li>

296

<li>

297

Directory names and file names should never contain

298

blanks or

299

non-printing characters.

300

</li>

301

<li>

302

Generated source or binary files should NEVER be added to

303

the repository (that includes <tt>javah</tt> output).

304

There are some exceptions to this rule, in particular

305

with some of the generated configure scripts.

306

</li>

307

<li>

308

Files not needed for typical building

309

or testing of the repository

310

should not be added to the repository.

311

</li>

Kelly O'Hair

2008-09-17 13:30:32 -0700

[diff] [blame]

312

</ul>

313

</blockquote>

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

314

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

315

</blockquote>

316

317

318

<hr>

319

<h2><a name="building">Building</a></h2>

320

321

The very first step in building the OpenJDK is making sure the

322

system itself has everything it needs to do OpenJDK builds.

323

Once a system is setup, it generally doesn't need to be done again.

324

<br>

325

Building the OpenJDK is now done with running a

326

<a href="#configure"><code>configure</code></a>

327

script which will try and find and verify you have everything

328

you need, followed by running

329

<a href="#gmake"><code>make</code></a>, e.g.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

330

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

<b>

<code>

bash ./configure<br>

make all

</code>

</b>

</blockquote>

Where possible the <code>configure</code> script will attempt to located the

339

various components in the default locations or via component

340

specific variable settings.

341

When the normal defaults fail or components cannot be found,

342

additional <code>configure</code> options may be necessary to help <code>configure</code>

343

find the necessary tools for the build, or you may need to

344

re-visit the setup of your system due to missing software

345

packages.

346

<br>

347

<strong>NOTE:</strong> The <code>configure</code> script

348

file does not have

349

execute permissions and will need to be explicitly run with

350

<code>bash</code>,

351

see the <a href="#guidelines">source guidelines</a>.

352

353

354

<hr>

355

<h3><a name="setup">System Setup</a></h3>

356

357

Before even attempting to use a system to build the OpenJDK

358

there are some very basic system setups needed.

359

For all systems:

360

<ul>

361

<li>

Erik Joelsson

6e76eef

2015-04-17 10:43:28 +0200

[diff] [blame]

362

Be sure the GNU make utility is version 3.81 (4.0 on

363

windows) or newer, e.g. run "<code>make -version</code>"

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

364

</li>

365

<li>

366

Install a

Stuart Marks

2013-06-18 17:18:46 -0700

[diff] [blame]

367

<a name="bootjdk">Bootstrap JDK</a>.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

368

All OpenJDK builds require access to a previously released

Stuart Marks

2013-06-18 17:18:46 -0700

[diff] [blame]

369

JDK called the <i>bootstrap JDK</i> or <i>boot JDK.</i>

370

The general rule is that the bootstrap JDK

371

must be an instance of the previous major

372

release of the JDK. In addition, there may be

373

a requirement to use a release at or beyond a

374

particular update level.

375

376

Erik Joelsson

2014-04-24 10:21:58 +0200

[diff] [blame]

377

<b><i>Building JDK 9 requires JDK 8. JDK 9

378

developers should not use JDK 9 as the boot

379

JDK, to ensure that JDK 9 dependencies are

Stuart Marks

2013-06-18 17:18:46 -0700

[diff] [blame]

380

not introduced into the parts of the system

Erik Joelsson

2014-04-24 10:21:58 +0200

[diff] [blame]

381

that are built with JDK 8.</i></b>

Stuart Marks

2013-06-18 17:18:46 -0700

[diff] [blame]

382

383

Erik Joelsson

2014-04-24 10:21:58 +0200

[diff] [blame]

384

The JDK 8 binaries can be downloaded from Oracle's

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

385

<a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html"

Erik Joelsson

2014-04-24 10:21:58 +0200

[diff] [blame]

386

target="_blank">JDK 8 download site</a>.

387

For build performance reasons it

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

388

is very important that this bootstrap JDK be made available

389

on the local disk of the machine doing the build.

390

You should add its <code>bin</code> directory

391

to the <code>PATH</code> environment variable.

392

If <code>configure</code> has any issues finding this JDK, you may

393

need to use the <code>configure</code> option

394

<code>--with-boot-jdk</code>.

395

</li>

396

<li>

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

397

Ensure that GNU make, the Bootstrap JDK,

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

398

and the compilers are all

399

in your PATH environment variable

400

</li>

401

</ul>

402

And for specific systems:

<thead>

<tr>

<th>Linux</th>

<th>Solaris</th>

<th>Windows</th>

</tr>

</thead>

<tbody>

<tr>

<td>

Install all the software development

416

packages needed including

417

<a href="#alsa">alsa</a>,

418

<a href="#freetype">freetype</a>,

419

<a href="#cups">cups</a>, and

420

<a href="#xrender">xrender</a>.

421

<br>

422

See

423

<a href="#SDBE">specific system packages</a>.

424

</td>

425

<td>

426

Install all the software development

427

packages needed including

428

<a href="#studio">Studio Compilers</a>,

429

<a href="#freetype">freetype</a>,

430

<a href="#cups">cups</a>, and

431

<a href="#xrender">xrender</a>.

432

<br>

433

See

434

<a href="#SDBE">specific system packages</a>.

</td>

<td>

<ul>

<li>

Install one of

<a href="#cygwin">CYGWIN</a> or

441

<a href="#msys">MinGW/MSYS</a>

442

</li>

443

<li>

444

Install

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

445

<a href="#vs2013">Visual Studio 2013</a>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

446

</li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</ul>

</td>

<td>

Install

<a href="https://developer.apple.com/xcode/">XCode 4.5.2</a>

452

and also install the "Command line tools" found under the

453

preferences pane "Downloads"

</td>

</tr>

</tbody>

</table>

<h4><a name="linux">Linux</a></h4>

460

461

With Linux, try and favor the system packages over

462

building your own

463

or getting packages from other areas.

464

Most Linux builds should be possible with the system's

465

available packages.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

466

<br>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

467

Note that some Linux systems have a habit of pre-populating

468

your environment variables for you, for example <code>JAVA_HOME</code>

469

might get pre-defined for you to refer to the JDK installed on

470

your Linux system.

471

You will need to unset <code>JAVA_HOME</code>.

472

It's a good idea to run <code>env</code> and verify the

473

environment variables you are getting from the default system

474

settings make sense for building the OpenJDK.

</blockquote>

<h4><a name="solaris">Solaris</a></h4>

479

480

<h5><a name="studio">Studio Compilers</a></h5>

At a minimum, the

Studio 12 Update 1 Compilers</a>

485

(containing version 5.10 of the C and C++ compilers) is required,

486

including specific patches.

487

<p>

488

The Solaris SPARC patch list is:

489

<ul>

490

<li>

491

118683-05: SunOS 5.10: Patch for profiling libraries and assembler

492

</li>

493

<li>

494

119963-21: SunOS 5.10: Shared library patch for C++

495

</li>

496

<li>

497

120753-08: SunOS 5.10: Microtasking libraries (libmtsk) patch

498

</li>

499

<li>

500

128228-09: Sun Studio 12 Update 1: Patch for Sun C++ Compiler

501

</li>

502

<li>

503

141860-03: Sun Studio 12 Update 1: Patch for Compiler Common patch for Sun C C++ F77 F95

504

</li>

505

<li>

506

141861-05: Sun Studio 12 Update 1: Patch for Sun C Compiler

507

</li>

508

<li>

509

142371-01: Sun Studio 12.1 Update 1: Patch for dbx

510

</li>

511

<li>

512

143384-02: Sun Studio 12 Update 1: Patch for debuginfo handling

513

</li>

514

<li>

515

143385-02: Sun Studio 12 Update 1: Patch for Compiler Common patch for Sun C C++ F77 F95

516

</li>

517

<li>

518

142369-01: Sun Studio 12.1: Patch for Performance Analyzer Tools

</li>

</ul>

<p>

The Solaris X86 patch list is:

523

<ul>

524

<li>

525

119961-07: SunOS 5.10_x86, x64, Patch for profiling libraries and assembler

526

</li>

527

<li>

528

119964-21: SunOS 5.10_x86: Shared library patch for C++_x86

529

</li>

530

<li>

531

120754-08: SunOS 5.10_x86: Microtasking libraries (libmtsk) patch

532

</li>

533

<li>

534

141858-06: Sun Studio 12 Update 1_x86: Sun Compiler Common patch for x86 backend

535

</li>

536

<li>

537

128229-09: Sun Studio 12 Update 1_x86: Patch for C++ Compiler

538

</li>

539

<li>

540

142363-05: Sun Studio 12 Update 1_x86: Patch for C Compiler

541

</li>

542

<li>

543

142368-01: Sun Studio 12.1_x86: Patch for Performance Analyzer Tools

</li>

</ul>

<p>

Place the <code>bin</code> directory in <code>PATH</code>.

548

<p>

549

The Oracle Solaris Studio Express compilers at:

550

551

Oracle Solaris Studio Express Download site</a>

552

are also an option, although these compilers have not

553

been extensively used yet.

554

</blockquote>

555

556

</blockquote>

557

558

<h4><a name="windows">Windows</a></h4>

559

560

561

<h5><a name="toolkit">Windows Unix Toolkit</a></h5>

562

563

Building on Windows requires a Unix-like environment, notably a

564

Unix-like shell.

565

There are several such environments available of which

566

<a href="http://www.cygwin.com/">Cygwin</a> and

567

<a href="http://www.mingw.org/wiki/MSYS">MinGW/MSYS</a> are

568

currently supported for

569

the OpenJDK build. One of the differences of these

570

systems from standard Windows tools is the way

571

they handle Windows path names, particularly path names which contain

572

spaces, backslashes as path separators and possibly drive letters.

573

Depending

574

on the use case and the specifics of each environment these path

575

problems can

576

be solved by a combination of quoting whole paths, translating

577

backslashes to

578

forward slashes, escaping backslashes with additional backslashes and

579

translating the path names to their

"8.3" version</a>.

<h6><a name="cygwin">CYGWIN</a></h6>

584

585

CYGWIN is an open source, Linux-like environment which tries to emulate

586

a complete POSIX layer on Windows. It tries to be smart about path names

587

and can usually handle all kinds of paths if they are correctly quoted

588

or escaped although internally it maps drive letters <code><drive>:</code>

589

to a virtual directory <code>/cygdrive/<drive></code>.

590

<p>

591

You can always use the <code>cygpath</code> utility to map pathnames with spaces

592

or the backslash character into the <code>C:/</code> style of pathname

593

(called 'mixed'), e.g. <code>cygpath -s -m "<i>path</i>"</code>.

594

</p>

595

<p>

596

Note that the use of CYGWIN creates a unique problem with regards to

597

setting <a href="#path"><code>PATH</code></a>. Normally on Windows

598

the <code>PATH</code> variable contains directories

599

separated with the ";" character (Solaris and Linux use ":").

600

With CYGWIN, it uses ":", but that means that paths like "C:/path"

601

cannot be placed in the CYGWIN version of <code>PATH</code> and

602

instead CYGWIN uses something like <code>/cygdrive/c/path</code>

603

which CYGWIN understands, but only CYGWIN understands.

604

</p>

605

<p>

606

The OpenJDK build requires CYGWIN version 1.7.16 or newer.

607

Information about CYGWIN can

608

be obtained from the CYGWIN website at

609

<a href="http://www.cygwin.com" target="_blank">www.cygwin.com</a>.

610

</p>

611

<p>

612

By default CYGWIN doesn't install all the tools required for building

613

the OpenJDK.

614

Along with the default installation, you need to install

the following tools.

<thead>

<tr>

<td>Binary Name</td>

<td>Category</td>

<td>Package</td>

<td>Description</td>

</tr>

</thead>

<tbody>

<tr>

<td>Devel</td>

<td>binutils</td>

<td>

The GNU assembler, linker and binary utilities

</td>

</tr>

<tr>

<td>Devel</td>

<td>

The GNU version of the 'make' utility built for CYGWIN

</td>

</tr>

<tr>

<td>Interpreters</td>

646

647

<td>

648

GNU implementation of the traditional Unix macro

processor

</td>

</tr>

<tr>

<td>Utils</td>

<td>

A program to manage archives of files

</td>

</tr>

<tr>

<td>Utils</td>

<td>

Pattern-directed scanning and processing language

</td>

</tr>

<tr>

<td>Utils</td>

<td>

Determines file type using 'magic' numbers

</td>

</tr>

<tr>

<td>Archive</td>

<td>

Package and compress (archive) files

</td>

</tr>

<tr>

<td>unzip.exe</td>

<td>Archive</td>

<td>unzip</td>

<td>

Extract compressed files in a ZIP archive

</td>

</tr>

<tr>

<td>System</td>

<td>procps</td>

<td>

Display amount of free and used memory in the system

</td>

</tr>

</tbody>

</table>

</blockquote>

Note that the CYGWIN software can conflict with other non-CYGWIN

704

software on your Windows system.

705

CYGWIN provides a

706

<a href="http://cygwin.com/faq/faq.using.html" target="_blank">FAQ</a> for

707

known issues and problems, of particular interest is the

708

section on

709

710

BLODA (applications that interfere with CYGWIN)</a>.

711

</blockquote>

712

713

<h6><a name="msys">MinGW/MSYS</a></h6>

714

715

MinGW ("Minimalist GNU for Windows") is a collection of free Windows

716

specific header files and import libraries combined with GNU toolsets that

717

allow one to produce native Windows programs that do not rely on any

718

3rd-party C runtime DLLs. MSYS is a supplement to MinGW which allows building

719

applications and programs which rely on traditional UNIX tools to

720

be present. Among others this includes tools like <code>bash</code>

721

and <code>make</code>.

722

See <a href="http://www.mingw.org/wiki/MSYS" target="_blank">MinGW/MSYS</a>

723

for more information.

724

<p>

725

Like Cygwin, MinGW/MSYS can handle different types of path formats. They

726

are internally converted to paths with forward slashes and drive letters

727

<code><drive>:</code> replaced by a virtual

728

directory <code>/<drive></code>. Additionally, MSYS automatically

729

detects binaries compiled for the MSYS environment and feeds them with the

730

internal, Unix-style path names. If native Windows applications are called

731

from within MSYS programs their path arguments are automatically converted

732

back to Windows style path names with drive letters and backslashes as

733

path separators. This may cause problems for Windows applications which

734

use forward slashes as parameter separator (e.g. <code>cl /nologo /I</code>)

735

because MSYS may wrongly <a href="http://mingw.org/wiki/Posix_path_conversion">

736

replace such parameters by drive letters</a>.

737

</p>

738

<p>

739

In addition to the tools which will be installed

740

by default, you have

741

to manually install the

742

<code>msys-zip</code> and

743

<code>msys-unzip</code> packages.

744

This can be easily done with the MinGW command line installer:

745

746

<code>mingw-get.exe install msys-zip</code>

747

<br>

748

<code>mingw-get.exe install msys-unzip</code>

</blockquote>

</blockquote>

</blockquote>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

754

<h5><a name="vs2013">Visual Studio 2013 Compilers</a></h5>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

755

756

<p>

757

The 32-bit and 64-bit OpenJDK Windows build requires

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

758

Microsoft Visual Studio C++ 2013 (VS2013) Professional

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

759

Edition or Express compiler.

760

The compiler and other tools are expected to reside

761

in the location defined by the variable

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

762

<code>VS120COMNTOOLS</code> which

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

763

is set by the Microsoft Visual Studio installer.

764

</p>

765

<p>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

766

Only the C++ part of VS2013 is needed.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

767

Try to let the installation go to the default

768

install directory.

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

769

Always reboot your system after installing VS2013.

770

The system environment variable VS120COMNTOOLS

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

771

should be

772

set in your environment.

773

</p>

774

<p>

775

Make sure that TMP and TEMP are also set

776

in the environment

777

and refer to Windows paths that exist,

778

like <code>C:\temp</code>,

779

not <code>/tmp</code>, not <code>/cygdrive/c/temp</code>,

780

and not <code>C:/temp</code>.

781

<code>C:\temp</code> is just an example,

782

it is assumed that this area is

783

private to the user, so by default

784

after installs you should

785

see a unique user path in these variables.

</p>

</blockquote>

</blockquote>

Make sure you get the right XCode version.

795

</blockquote>

</blockquote>

800

<hr>

801

<h3><a name="configure">Configure</a></h3>

802

803

The basic invocation of the <code>configure</code> script

804

looks like:

805

806

<b><code>bash ./configure [<i>options</i>]</code></b>

807

</blockquote>

808

This will create an output directory containing the

809

"configuration" and setup an area for the build result.

810

This directory typically looks like:

811

812

<b><code>build/linux-x64-normal-server-release</code></b>

813

</blockquote>

814

<code>configure</code> will try to figure out what system you are running on

815

and where all necessary build components are.

816

If you have all prerequisites for building installed,

817

it should find everything.

818

If it fails to detect any component automatically,

819

it will exit and inform you about the problem.

820

When this happens, read more below in

821

<a href="#configureoptions">the <code>configure</code> options</a>.

<p>

Some examples:

</p>

<thead>

<tr>

<th>Description</th>

<th>Configure Command Line</th>

</tr>

</thead>

<tbody>

<tr>

<td>Windows 32bit build with freetype specified</td>

835

<td>

836

<code>bash ./configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-bits=32</code>

</td>

</tr>

<tr>

<td>Debug 64bit Build</td>

841

<td>

842

<code>bash ./configure --enable-debug --with-target-bits=64</code>

</td>

</tr>

</tbody>

</table>

849

<h4><a name="configureoptions">Configure Options</a></h4>

850

851

Complete details on all the OpenJDK <code>configure</code> options can

852

be seen with:

853

854

<b><code>bash ./configure --help=short</code></b>

855

</blockquote>

856

Use <code>-help</code> to see all the <code>configure</code> options

857

available.

858

859

You can generate any number of different configurations,

860

e.g. debug, release, 32, 64, etc.

861

862

Some of the more commonly used <code>configure</code> options are:

<thead>

<tr>

<th width="300">OpenJDK Configure Option</th>

<th>Description</th>

</tr>

</thead>

<tbody>

<tr>

<td><b><code>--enable-debug</code></b></td>

874

<td>

875

set the debug level to fastdebug (this is a shorthand for

876

<code>--with-debug-level=fastdebug</code>)

</td>

</tr>

<tr>

<td>

select the location of the

883

<a name="alsa">Advanced Linux Sound Architecture (ALSA)</a>

884

<br>

885

Version 0.9.1 or newer of the ALSA files are

886

required for building the OpenJDK on Linux.

887

These Linux files are usually available from an "alsa"

888

of "libasound"

889

development package,

890

and it's highly recommended that you try and use

891

the package provided by the particular version of Linux that

you are using.

</td>

</tr>

<tr>

<td>

select the <a href="#bootjdk">Bootstrap JDK</a>

</td>

</tr>

<tr>

<td><b><code>--with-boot-jdk-jvmargs=</code></b>"<i>args</i>"</td>

903

<td>

904

provide the JVM options to be used to run the

905

<a href="#bootjdk">Bootstrap JDK</a>

</td>

</tr>

<tr>

<td><b><code>--with-cacerts=</code></b><i>path</i></td>

910

<td>

911

select the path to the cacerts file.

912

<br>

913

See <a href="http://en.wikipedia.org/wiki/Certificate_Authority" target="_blank">

914

http://en.wikipedia.org/wiki/Certificate_Authority</a>

915

for a better understanding of the Certificate Authority (CA).

916

A certificates file named "cacerts"

917

represents a system-wide keystore with CA certificates.

918

In JDK and JRE

919

binary bundles, the "cacerts" file contains root CA certificates from

920

several public CAs (e.g., VeriSign, Thawte, and Baltimore).

921

The source contain a cacerts file

922

without CA root certificates.

923

Formal JDK builders will need to secure

924

permission from each public CA and include the certificates into their

925

own custom cacerts file.

926

Failure to provide a populated cacerts file

927

will result in verification errors of a certificate chain during runtime.

928

By default an empty cacerts file is provided and that should be

929

fine for most JDK developers.

</td>

</tr>

<tr>

<td>

select the CUPS install location

936

<br>

937

The

938

<a name="cups">Common UNIX Printing System (CUPS) Headers</a>

939

are required for building the

940

OpenJDK on Solaris and Linux.

941

The Solaris header files can be obtained by installing

942

the package <strong>SFWcups</strong> from the Solaris Software

943

Companion CD/DVD, these often will be installed into the

944

directory <code>/opt/sfw/cups</code>.

945

<br>

946

The CUPS header files can always be downloaded from

947

<a href="http://www.cups.org" target="_blank">www.cups.org</a>.

</td>

</tr>

<tr>

<td><b><code>--with-cups-include=</code></b><i>path</i></td>

952

<td>

953

select the CUPS include directory location

</td>

</tr>

<tr>

<td><b><code>--with-debug-level=</code></b><i>level</i></td>

958

<td>

959

select the debug information level of release,

960

fastdebug, or slowdebug

</td>

</tr>

<tr>

<td>

select location of the compiler install or

967

developer install location

968

</td>

969

</tr>

970

<tr>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

971

<td><b><code>--with-freetype=</code></b><i>path</i></td>

972

<td>

973

select the freetype files to use.

974

<br>

975

Expecting the

976

<a name="freetype">freetype</a> libraries under

977

<code>lib/</code> and the

978

headers under <code>include/</code>.

979

<br>

980

Version 2.3 or newer of FreeType is required.

981

On Unix systems required files can be available as part of your

982

distribution (while you still may need to upgrade them).

983

Note that you need development version of package that

984

includes both the FreeType library and header files.

985

<br>

986

You can always download latest FreeType version from the

987

<a href="http://www.freetype.org" target="_blank">FreeType website</a>.

988

<br>

989

Building the freetype 2 libraries from scratch is also possible,

990

however on Windows refer to the

991

992

Windows FreeType DLL build instructions</a>.

993

<br>

994

Note that by default FreeType is built with byte code hinting

995

support disabled due to licensing restrictions.

996

In this case, text appearance and metrics are expected to

997

differ from Sun's official JDK build.

998

See

999

1000

the SourceForge FreeType2 Home Page

1001

</a>

1002

for more information.

</td>

</tr>

<tr>

<td><b><code>--with-import-hotspot=</code></b><i>path</i></td>

1007

<td>

1008

select the location to find hotspot

1009

binaries from a previous build to avoid building

hotspot

</td>

</tr>

<tr>

<td><b><code>--with-target-bits=</code></b><i>arg</i></td>

1015

<td>

1016

select 32 or 64 bit build

</td>

</tr>

<tr>

<td><b><code>--with-jvm-variants=</code></b><i>variants</i></td>

1021

<td>

1022

select the JVM variants to build from, comma

1023

separated list that can include:

1024

server, client, kernel, zero and zeroshark

</td>

</tr>

<tr>

<td><b><code>--with-memory-size=</code></b><i>size</i></td>

1029

<td>

1030

select the RAM size that GNU make will think

this system has

</td>

</tr>

<tr>

<td><a name="msvcrNN"><b><code>--with-msvcr-dll=</code></b><i>path</i></a></td>

1036

<td>

1037

select the <code>msvcr100.dll</code>

1038

file to include in the

1039

Windows builds (C/C++ runtime library for

1040

Visual Studio).

1041

<br>

1042

This is usually picked up automatically

1043

from the redist

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1044

directories of Visual Studio 2013.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</td>

</tr>

<tr>

<td><b><code>--with-num-cores=</code></b><i>cores</i></td>

1049

<td>

1050

select the number of cores to use (processor

count or CPU count)

</td>

</tr>

<tr>

<td>

select the location of the X11 and xrender files.

1058

<br>

1059

The

1060

<a name="xrender">XRender Extension Headers</a>

1061

are required for building the

1062

OpenJDK on Solaris and Linux.

1063

<br>

1064

The Linux header files are usually available from a "Xrender"

1065

development package, it's recommended that you try and use

1066

the package provided by the particular distribution of Linux that

1067

you are using.

1068

<br>

1069

The Solaris XRender header files is

1070

included with the other X11 header files

1071

in the package <strong>SFWxwinc</strong>

1072

on new enough versions of

1073

Solaris and will be installed in

1074

<code>/usr/X11/include/X11/extensions/Xrender.h</code> or

1075

<code>/usr/openwin/share/include/X11/extensions/Xrender.h</code>

</td>

</tr>

</tbody>

</table>

</blockquote>

</blockquote>

<hr>

The basic invocation of the <code>make</code> utility

looks like:

</blockquote>

This will start the build to the output directory containing the

1094

"configuration" that was created by the <code>configure</code>

1095

script. Run <code>make help</code> for more information on

1096

the available targets.

1097

<br>

1098

There are some of the make targets that

1099

are of general interest:

<thead>

<tr>

<th>Make Target</th>

<th>Description</th>

</tr>

</thead>

<tbody>

<tr>

<td><i>empty</i></td>

1110

<td>build everything but no images</td>

</tr>

<tr>

<td>build everything including images</td>

</tr>

<tr>

<td>build all configurations</td>

1119

</tr>

1120

<tr>

1121

<td><b><code>images</code></b></td>

1122

<td>create complete j2sdk and j2re images</td>

1123

</tr>

1124

<tr>

1125

<td><b><code>install</code></b></td>

1126

<td>install the generated images locally,

1127

typically in <code>/usr/local</code></td>

1128

</tr>

1129

<tr>

1130

<td><b><code>clean</code></b></td>

1131

<td>remove all files generated by make,

1132

but not those generated by <code>configure</code></td>

1133

</tr>

1134

<tr>

1135

<td><b><code>dist-clean</code></b></td>

1136

<td>remove all files generated by both

1137

and <code>configure</code> (basically killing the configuration)</td>

</tr>

<tr>

<td>give some help on using <code>make</code>,

1142

including some interesting make targets</td>

</tr>

</tbody>

</table>

</blockquote>

</blockquote>

1150

<hr>

1151

<h2><a name="testing">Testing</a></h2>

1152

1153

When the build is completed, you should see the generated

1154

binaries and associated files in the <code>j2sdk-image</code>

1155

directory in the output directory.

1156

In particular, the

1157

<code>build/<i>*</i>/images/j2sdk-image/bin</code>

1158

directory should contain executables for the

1159

OpenJDK tools and utilities for that configuration.

1160

The testing tool <code>jtreg</code> will be needed

and can be found at:

the jtreg site</a>.

The provided regression tests in the repositories

1165

can be run with the command:

1166

1167

<code><b>cd test && make PRODUCT_HOME=`pwd`/../build/*/images/j2sdk-image all</b></code>

</blockquote>

</blockquote>

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

<hr>

1183

<h2><a name="hints">Appendix A: Hints and Tips</a></h2>

<p>

Erik Joelsson

2013-08-30 10:13:25 +0200

[diff] [blame]

1190

<b>Q:</b> The <code>generated-configure.sh</code> file looks horrible!

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1191

How are you going to edit it?

1192

<br>

Erik Joelsson

2013-08-30 10:13:25 +0200

[diff] [blame]

1193

<b>A:</b> The <code>generated-configure.sh</code> file is generated (think

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1194

"compiled") by the autoconf tools. The source code is

Erik Joelsson

2013-08-30 10:13:25 +0200

[diff] [blame]

1195

in <code>configure.ac</code> and various .m4 files in common/autoconf,

1196

which are much more readable.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1197

</p>

1198

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1199

<p>

1200

Erik Joelsson

2013-08-30 10:13:25 +0200

[diff] [blame]

1201

Why is the <code>generated-configure.sh</code> file checked in,

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

if it is generated?

<br>

If it was not generated, every user would need to have the autoconf

1206

tools installed, and re-generate the <code>configure</code> file

1207

as the first step.

1208

Our goal is to minimize the work needed to be done by the user

1209

to start building OpenJDK, and to minimize

1210

the number of external dependencies required.

</p>

<p>

Do you require a specific version of autoconf for regenerating

Erik Joelsson

2013-08-30 10:13:25 +0200

[diff] [blame]

1216

<code>generated-configure.sh</code>?

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1217

<br>

1218

Erik Joelsson

2013-08-30 10:13:25 +0200

[diff] [blame]

1219

Yes, version 2.69 is required and should be easy

1220

enough to aquire on all supported operating

1221

systems. The reason for this is to avoid

1222

large spurious changes in <code>generated-configure.sh</code>.

</p>

<p>

How do you regenerate <code>generated-configure.sh</code>

1228

after making changes to the input files?

1229

<br>

1230

1231

Regnerating <code>generated-configure.sh</code>

1232

should always be done using the

1233

script <code>common/autoconf/autogen.sh</code> to

1234

ensure that the correct files get updated. This

1235

script should also be run after mercurial tries to

1236

merge <code>generated-configure.sh</code> as a

1237

merge of the generated file is not guaranteed to

1238

be correct.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</p>

<p>

What are the files in <code>common/makefiles/support/*</code> for?

1244

They look like gibberish.

1245

<br>

1246

1247

They are a somewhat ugly hack to compensate for command line length

1248

limitations on certain platforms (Windows, Solaris).

1249

Due to a combination of limitations in make and the shell,

1250

command lines containing too many files will not work properly.

1251

These

1252

helper files are part of an elaborate hack that will compress the

1253

command line in the makefile and then uncompress it safely.

1254

We're

1255

not proud of it, but it does fix the problem.

1256

If you have any better suggestions, we're all ears! :-)

</p>

<p>

I want to see the output of the commands that make runs,

1262

like in the old build. How do I do that?

1263

<br>

1264

1265

You specify the <code>LOG</code> variable to make. There are

1266

several log levels:

1267

</p>

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1268

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1269

<ul>

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1270

<li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1271

<b><code>warn</code></b> — Default and very quiet.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1272

</li>

1273

<li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1274

<b><code>info</code></b> — Shows more progress information

1275

than warn.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1276

</li>

1277

<li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1278

<b><code>debug</code></b> — Echos all command lines and

1279

prints all macro calls for compilation definitions.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1280

</li>

1281

<li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1282

<b><code>trace</code></b> — Echos all $(shell) command

1283

lines as well.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1284

</li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1285

</ul>

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1286

</blockquote>

1287

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1288

<p>

1289

1290

When do I have to re-run <code>configure</code>?

1291

<br>

1292

1293

Normally you will run <code>configure</code> only once for creating a

1294

configuration.

1295

You need to re-run configuration only if you want to change any

1296

configuration options,

1297

or if you pull down changes to the <code>configure</code> script.

</p>

<p>

I have added a new source file. Do I need to modify the makefiles?

1303

<br>

1304

1305

Normally, no. If you want to create e.g. a new native

1306

library,

1307

you will need to modify the makefiles. But for normal file

1308

additions or removals, no changes are needed. There are certan

1309

exceptions for some native libraries where the source files are spread

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

1310

over many directories which also contain sources for other

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1311

libraries. In these cases it was simply easier to create include lists

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

1312

rather than excludes.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</p>

<p>

When I run <code>configure --help</code>, I see many strange options,

1318

like <code>--dvidir</code>. What is this?

1319

<br>

1320

1321

Configure provides a slew of options by default, to all projects

1322

that use autoconf. Most of them are not used in OpenJDK,

1323

so you can safely ignore them. To list only OpenJDK specific features,

1324

use <code>configure --help=short</code> instead.

</p>

<p>

<code>configure</code> provides OpenJDK-specific features such as

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

1330

<code>--with-builddeps-server</code> that are not

1331

described in this document. What about those?

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1332

<br>

1333

1334

Try them out if you like! But be aware that most of these are

1335

experimental features.

1336

Many of them don't do anything at all at the moment; the option

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

1337

is just a placeholder. Others depend on

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1338

pieces of code or infrastructure that is currently

1339

not ready for prime time.

</p>

<p>

How will you make sure you don't break anything?

1345

<br>

1346

1347

We have a script that compares the result of the new build system

1348

with the result of the old. For most part, we aim for (and achieve)

1349

byte-by-byte identical output. There are however technical issues

1350

with e.g. native binaries, which might differ in a byte-by-byte

1351

comparison, even

1352

when building twice with the old build system.

1353

For these, we compare relevant aspects

1354

(e.g. the symbol table and file size).

1355

Note that we still don't have 100%

1356

equivalence, but we're close.

</p>

<p>

I noticed this thing X in the build that looks very broken by design.

1362

Why don't you fix it?

1363

<br>

1364

1365

Our goal is to produce a build output that is as close as

1366

technically possible to the old build output.

1367

If things were weird in the old build,

1368

they will be weird in the new build.

1369

Often, things were weird before due to obscurity,

1370

but in the new build system the weird stuff comes up to the surface.

1371

The plan is to attack these things at a later stage,

1372

after the new build system is established.

</p>

<p>

The code in the new build system is not that well-structured.

Will you fix this?

<br>

Yes! The new build system has grown bit by bit as we converted

1382

the old system. When all of the old build system is converted,

1383

we can take a step back and clean up the structure of the new build

1384

system. Some of this we plan to do before replacing the old build

1385

system and some will need to wait until after.

1386

</p>

1387

1388

<p>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1389

1390

Is anything able to use the results of the new build's default make target?

1391

<br>

1392

1393

Yes, this is the minimal (or roughly minimal)

1394

set of compiled output needed for a developer to actually

1395

execute the newly built JDK. The idea is that in an incremental

1396

development fashion, when doing a normal make,

1397

you should only spend time recompiling what's changed

1398

(making it purely incremental) and only do the work that's

1399

needed to actually run and test your code.

1400

The packaging stuff that is part of the <code>images</code>

1401

target is not needed for a normal developer who wants to

1402

test his new code. Even if it's quite fast, it's still unnecessary.

1403

We're targeting sub-second incremental rebuilds! ;-)

1404

(Or, well, at least single-digit seconds...)

</p>

<p>

I usually set a specific environment variable when building,

1410

but I can't find the equivalent in the new build.

What should I do?

<br>

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

1414

It might very well be that we have neglected to add support for

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1415

an option that was actually used from outside the build system.

Erik Joelsson

2013-08-26 13:43:27 +0200

[diff] [blame]

1416

Email us and we will add support for it!

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1417

</p>

1418

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1419

</blockquote>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1420

1421

<h3><a name="performance">Build Performance Tips</a></h3>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1422

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1423

1424

<p>Building OpenJDK requires a lot of horsepower.

1425

Some of the build tools can be adjusted to utilize more or less

1426

of resources such as

1427

parallel threads and memory.

1428

The <code>configure</code> script analyzes your system and selects reasonable

1429

values for such options based on your hardware.

1430

If you encounter resource problems, such as out of memory conditions,

1431

you can modify the detected values with:</p>

<ul>

<li>

<b><code>--with-num-cores</code></b>

1436

—

1437

number of cores in the build system,

1438

e.g. <code>--with-num-cores=8</code>

1439

</li>

1440

<li>

1441

<b><code>--with-memory-size</code></b>

1442

— memory (in MB) available in the build system,

1443

e.g. <code>--with-memory-size=1024</code>

</li>

</ul>

<p>It might also be necessary to specify the JVM arguments passed

1448

to the Bootstrap JDK, using e.g.

1449

<code>--with-boot-jdk-jvmargs="-Xmx8G -enableassertions"</code>.

1450

Doing this will override the default JVM arguments

1451

passed to the Bootstrap JDK.</p>

1452

1453

1454

<p>One of the top goals of the new build system is to improve the

1455

build performance and decrease the time needed to build. This will

1456

soon also apply to the java compilation when the Smart Javac wrapper

Erik Joelsson

2014-04-24 10:21:58 +0200

[diff] [blame]

1457

is fully supported.</p>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1458

1459

<p>At the end of a successful execution of <code>configure</code>,

1460

you will get a performance summary,

1461

indicating how well the build will perform. Here you will

1462

also get performance hints.

1463

If you want to build fast, pay attention to those!</p>

1464

1465

<h4>Building with ccache</h4>

1466

Erik Joelsson

24bc773

2015-02-10 12:25:44 +0100

[diff] [blame]

1467

<p>The OpenJDK build supports building with ccache

1468

when using gcc or clang. Using ccache can

1469

radically speed up compilation of native code if

1470

you often rebuild the same sources. Your milage

1471

may vary however so we recommend evaluating it for

1472

yourself. To enable it, make sure it's on the path

1473

and configure with <code>--enable-ccache</code>.</p>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1474

1475

<h4>Building on local disk</h4>

1476

1477

<p>If you are using network shares, e.g. via NFS, for your source code,

1478

make sure the build directory is situated on local disk.

1479

The performance

1480

penalty is extremely high for building on a network share,

1481

close to unusable.</p>

1482

1483

<h4>Building only one JVM</h4>

1484

1485

<p>The old build builds multiple JVMs on 32-bit systems (client and

1486

server; and on Windows kernel as well). In the new build we have

1487

changed this default to only build server when it's available. This

1488

improves build times for those not interested in multiple JVMs. To

1489

mimic the old behavior on platforms that support it,

1490

use <code>--with-jvm-variants=client,server</code>.</p>

1491

1492

<h4>Selecting the number of cores to build on</h4>

1493

1494

<p>By default, <code>configure</code> will analyze your machine and run the make

1495

process in parallel with as many threads as you have cores. This

1496

behavior can be overridden, either "permanently" (on a <code>configure</code>

1497

basis) using <code>--with-num-cores=N</code> or for a single build

1498

only (on a make basis), using <code>make JOBS=N</code>.</p>

1499

1500

<p>If you want to make a slower build just this time, to save some CPU

1501

power for other processes, you can run

1502

e.g. <code>make JOBS=2</code>. This will force the makefiles

1503

to only run 2 parallel processes, or even <code>make JOBS=1</code>

1504

which will disable parallelism.</p>

1505

1506

<p>If you want to have it the other way round, namely having slow

1507

builds default and override with fast if you're

1508

impatient, you should call <code>configure</code> with

1509

<code>--with-num-cores=2</code>, making 2 the default.

1510

If you want to run with more

1511

cores, run <code>make JOBS=8</code></p>

1512

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

1513

</blockquote>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1514

1515

<h3><a name="troubleshooting">Troubleshooting</a></h3>

1516

1517

1518

<h4>Solving build problems</h4>

1519

1520

1521

If the build fails (and it's not due to a compilation error in

1522

a source file you've changed), the first thing you should do

1523

is to re-run the build with more verbosity.

1524

Do this by adding <code>LOG=debug</code> to your make command line.

1525

<br>

1526

The build log (with both stdout and stderr intermingled,

1527

basically the same as you see on your console) can be found as

1528

<code>build.log</code> in your build directory.

1529

<br>

1530

You can ask for help on build problems with the new build system

on either the

build-dev</a>

or the

build-infra-dev</a>

mailing lists. Please include the relevant parts

1538

of the build log.

1539

<br>

1540

A build can fail for any number of reasons.

1541

Most failures

1542

are a result of trying to build in an environment in which all the

1543

pre-build requirements have not been met.

1544

The first step in

1545

troubleshooting a build failure is to recheck that you have satisfied

1546

all the pre-build requirements for your platform.

1547

Scanning the <code>configure</code> log is a good first step, making

1548

sure that what it found makes sense for your system.

1549

Look for strange error messages or any difficulties that

1550

<code>configure</code> had in finding things.

1551

<br>

1552

Some of the more common problems with builds are briefly

1553

described

1554

below, with suggestions for remedies.

1555

<ul>

1556

<li>

1557

<b>Corrupted Bundles on Windows:</b>

1558

1559

Some virus scanning software has been known to

1560

corrupt the

1561

downloading of zip bundles.

1562

It may be necessary to disable the 'on access' or

1563

'real time'

1564

virus scanning features to prevent this corruption.

1565

This type of "real time" virus scanning can also

1566

slow down the

1567

build process significantly.

1568

Temporarily disabling the feature, or excluding the build

1569

output directory may be necessary to get correct and

faster builds.

</blockquote>

</li>

<li>

<b>Slow Builds:</b>

If your build machine seems to be overloaded from too many

1577

simultaneous C++ compiles, try setting the

1578

<code>JOBS=1</code> on the <code>make</code> command line.

1579

Then try increasing the count slowly to an acceptable

1580

level for your system. Also:

1581

1582

Creating the javadocs can be very slow,

1583

if you are running

1584

javadoc, consider skipping that step.

1585

<br>

1586

Faster CPUs, more RAM, and a faster DISK usually helps.

1587

The VM build tends to be CPU intensive

1588

(many C++ compiles),

1589

and the rest of the JDK will often be disk intensive.

1590

<br>

1591

Faster compiles are possible using a tool called

1592

<a href="http://ccache.samba.org/" target="_blank">ccache</a>.

</blockquote>

</blockquote>

</li>

<li>

<b>File time issues:</b>

1598

1599

If you see warnings that refer to file time stamps, e.g.

1600

1601

<i>Warning message:</i><code>

1602

File `xxx' has modification time in

1603

the future.</code>

1604

<br>

1605

<i>Warning message:</i> <code> Clock skew detected.

1606

Your build may

1607

be incomplete.</code>

1608

</blockquote>

1609

These warnings can occur when the clock on the build

1610

machine is out of

1611

sync with the timestamps on the source files.

1612

Other errors, apparently

1613

unrelated but in fact caused by the clock skew,

1614

can occur along with

1615

the clock skew warnings.

1616

These secondary errors may tend to obscure the

1617

fact that the true root cause of the problem

1618

is an out-of-sync clock.

1619

<p>

1620

If you see these warnings, reset the clock on the

1621

build

1622

machine, run "<code><i>gmake</i> clobber</code>"

1623

or delete the directory

1624

containing the build output, and restart the

1625

build from the beginning.

</blockquote>

</li>

<li>

<b>Error message:

<code>Trouble writing out table to disk</code></b>

1631

1632

Increase the amount of swap space on your build machine.

1633

This could be caused by overloading the system and

1634

it may be necessary to use:

</blockquote>

to reduce the load on the system.

</blockquote>

</li>

<li>

<b>Error Message:

<code>libstdc++ not found:</code></b>

1644

1645

This is caused by a missing libstdc++.a library.

1646

This is installed as part of a specific package

1647

(e.g. libstdc++.so.devel.386).

1648

By default some 64-bit Linux versions (e.g. Fedora)

1649

only install the 64-bit version of the libstdc++ package.

1650

Various parts of the JDK build require a static

1651

link of the C++ runtime libraries to allow for maximum

1652

portability of the built images.

</blockquote>

</li>

<li>

<b>Linux Error Message:

1657

<code>cannot restore segment prot after reloc</code></b>

1658

1659

This is probably an issue with SELinux (See

1660

1661

http://en.wikipedia.org/wiki/SELinux</a>).

1662

Parts of the VM is built without the <code>-fPIC</code> for

1663

performance reasons.

1664

<p>

1665

To completely disable SELinux:

1666

<ol>

1667

1668

<li><code># system-config-securitylevel</code></li>

1669

<li><code>In the window that appears, select the SELinux tab</code></li>

1670

<li><code>Disable SELinux</code></li>

1671

</ol>

1672

<p>

1673

Alternatively, instead of completely disabling it you could

1674

disable just this one check.

1675

<ol>

1676

<li>Select System->Administration->SELinux Management</li>

1677

<li>In the SELinux Management Tool which appears,

1678

select "Boolean" from the menu on the left</li>

1679

<li>Expand the "Memory Protection" group</li>

1680

<li>Check the first item, labeled

1681

"Allow all unconfined executables to use

1682

libraries requiring text relocation ..."</li>

</ol>

</blockquote>

</li>

<li>

<b>Windows Error Messages:</b>

1688

<br>

1689

<code>*** fatal error - couldn't allocate heap, ... </code>

1690

<br>

1691

<code>rm fails with "Directory not empty"</code>

1692

<br>

1693

<code>unzip fails with "cannot create ... Permission denied"</code>

1694

<br>

1695

<code>unzip fails with "cannot create ... Error 50"</code>

1696

<br>

1697

1698

The CYGWIN software can conflict with other non-CYGWIN

1699

software. See the CYGWIN FAQ section on

1700

1701

BLODA (applications that interfere with CYGWIN)</a>.

</blockquote>

</li>

<li>

<b>Windows Error Message: <code>spawn failed</code></b>

1706

1707

Try rebooting the system, or there could be some kind of

1708

issue with the disk or disk partition being used.

1709

Sometimes it comes with a "Permission Denied" message.

</blockquote>

</li>

</ul>

</blockquote>

</blockquote>

1716

1717

</blockquote>

1718

1719

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1720

<hr>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1721

<h2><a name="gmake">Appendix B: GNU make</a></h2>

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

1722

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1723

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1724

The Makefiles in the OpenJDK are only valid when used with the

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1725

GNU version of the utility command <code>make</code>

1726

(usually called <code>gmake</code> on Solaris).

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1727

A few notes about using GNU make:

1728

<ul>

1729

<li>

Erik Joelsson

6e76eef

2015-04-17 10:43:28 +0200

[diff] [blame]

1730

You need GNU make version 3.81 or newer. On Windows 4.0 or

1731

newer is recommended.

1732

If the GNU make utility on your systems is not of a suitable

1733

version see <a href="#buildgmake">"Building GNU make"</a>.

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1734

</li>

1735

<li>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1736

Place the location of the GNU make binary in the

1737

<code>PATH</code>.

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1738

</li>

1739

<li>

1740

<strong>Solaris:</strong>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1741

Do NOT use <code>/usr/bin/make</code> on Solaris.

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1742

If your Solaris system has the software

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1743

from the Solaris Developer Companion CD installed,

1744

you should try and use <code>gmake</code>

1745

which will be located in either the

1746

<code>/usr/bin</code>, <code>/opt/sfw/bin</code> or

1747

<code>/usr/sfw/bin</code> directory.

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1748

</li>

1749

<li>

1750

<strong>Windows:</strong>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1751

Make sure you start your build inside a bash shell.

</li>

<li>

The XCode "command line tools" must be installed on your Mac.

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1756

</li>

1757

</ul>

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

1758

<p>

Kelly O'Hair

2010-12-22 12:25:52 -0800

[diff] [blame]

1759

Information on GNU make, and access to ftp download sites, are

available on the

GNU make web site

</a>.

The latest source to GNU make is available at

1765

1766

ftp.gnu.org/pub/gnu/make/</a>.

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1767

</p>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1768

1769

<h3><a name="buildgmake">Building GNU make</a></h3>

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1770

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1771

First step is to get the GNU make 3.81 or newer source from

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1772

1773

ftp.gnu.org/pub/gnu/make/</a>.

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1774

Building is a little different depending on the OS but is

1775

basically done with:

1776

1777

<code>bash ./configure</code>

1778

<br>

1779

1780

</blockquote>

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

1781

</blockquote>

Edvard Wendelin

1f736c8

2012-05-03 14:17:30 +0200

[diff] [blame]

1782

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1783

</blockquote>

1784

1785

Edvard Wendelin

1f736c8

2012-05-03 14:17:30 +0200

[diff] [blame]

1786

<hr>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1787

<h2><a name="buildenvironments">Appendix C: Build Environments</a></h2>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1788

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1789

1790

<h3><a name="MBE">Minimum Build Environments</a></h3>

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

1791

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1792

This file often describes specific requirements for what we

1793

call the

1794

"minimum build environments" (MBE) for this

1795

specific release of the JDK.

1796

What is listed below is what the Oracle Release

1797

Engineering Team will use to build the Oracle JDK product.

1798

Building with the MBE will hopefully generate the most compatible

1799

bits that install on, and run correctly on, the most variations

1800

of the same base OS and hardware architecture.

1801

In some cases, these represent what is often called the

1802

least common denominator, but each Operating System has different

1803

aspects to it.

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

1804

<p>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1805

In all cases, the Bootstrap JDK version minimum is critical,

1806

we cannot guarantee builds will work with older Bootstrap JDK's.

1807

Also in all cases, more RAM and more processors is better,

1808

the minimums listed below are simply recommendations.

1809

<p>

1810

With Solaris and Mac OS X, the version listed below is the

1811

oldest release we can guarantee builds and works, and the

1812

specific version of the compilers used could be critical.

1813

<p>

1814

With Windows the critical aspect is the Visual Studio compiler

1815

used, which due to it's runtime, generally dictates what Windows

1816

systems can do the builds and where the resulting bits can

1817

be used.<br>

1818

<b>NOTE: We expect a change here off these older Windows OS releases

1819

and to a 'less older' one, probably Windows 2008R2 X64.</b>

1820

<p>

1821

With Linux, it was just a matter of picking a

1822

stable distribution that is a good representative for Linux

1823

in general.<br>

1824

<b>NOTE: We expect a change here from Fedora 9 to something else,

1825

but it has not been completely determined yet, possibly

1826

Ubuntu 12.04 X64, unbiased community feedback would be welcome on

1827

what a good choice would be here.</b>

1828

<p>

1829

It is understood that most developers will NOT be using these

1830

specific versions, and in fact creating these specific versions

1831

may be difficult due to the age of some of this software.

1832

It is expected that developers are more often using the more

1833

recent releases and distributions of these operating systems.

1834

<p>

1835

Compilation problems with newer or different C/C++ compilers is a

1836

common problem.

1837

Similarly, compilation problems related to changes to the

1838

<code>/usr/include</code> or system header files is also a

1839

common problem with older, newer, or unreleased OS versions.

1840

Please report these types of problems as bugs so that they

1841

can be dealt with accordingly.

</p>

<thead>

<tr>

<th>Base OS and Architecture</th>

1847

1848

<th>C/C++ Compiler</th>

1849

<th>Bootstrap JDK</th>

<th>Processors</th>

<th>RAM Minimum</th>

<th>DISK Needs</th>

</tr>

</thead>

<tbody>

<tr>

<td>Linux X86 (32-bit) and X64 (64-bit)</td>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1858

<td>Oracle Enterprise Linux 6.4</td>

1859

1860

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</tr>

<tr>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1866

<td>Solaris SPARCV9 (64-bit)</td>

1867

<td>Solaris 10 Update 10</td>

1868

<td>Studio 12 Update 3 + patches</td>

1869

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</tr>

<tr>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1875

<td>Solaris X64 (64-bit)</td>

1876

<td>Solaris 10 Update 10</td>

1877

<td>Studio 12 Update 3 + patches</td>

1878

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</tr>

<tr>

<td>Windows X86 (32-bit)</td>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1885

<td>Windows Server 2012 R2 x64</td>

1886

<td>Microsoft Visual Studio C++ 2013 Professional Edition</td>

1887

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</tr>

<tr>

<td>Windows X64 (64-bit)</td>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1894

<td>Windows Server 2012 R2 x64</td>

1895

<td>Microsoft Visual Studio C++ 2013 Professional Edition</td>

1896

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</tr>

<tr>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

1903

<td>Mac OS X 10.9 "Mavericks"</td>

1904

<td>XCode 5.1.1 or newer</td>

1905

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

</tr>

</tbody>

</table>

J. Duke

2007-12-01 00:00:00 +0000

[diff] [blame]

1912

</blockquote>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1913

1914

1915

<hr>

1916

<h3><a name="SDBE">Specific Developer Build Environments</a></h3>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

1917

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

1918

We won't be listing all the possible environments, but

1919

we will try to provide what information we have available to us.

1920

<p>

1921

<strong>NOTE: The community can help out by updating

1922

this part of the document.

1923

</strong>

1924

1925

<h4><a name="fedora">Fedora</a></h4>

1926

1927

After installing the latest

1928

<a href="http://fedoraproject.org">Fedora</a>

1929

you need to install several build dependencies.

1930

The simplest way to do it is to execute the

1931

following commands as user <code>root</code>:

1932

1933

<code>yum-builddep java-1.7.0-openjdk</code>

1934

<br>

1935

<code>yum install gcc gcc-c++</code>

1936

</blockquote>

1937

<p>

1938

In addition, it's necessary to set a few environment

1939

variables for the build:

1940

1941

<code>export LANG=C</code>

1942

<br>

1943

<code>export PATH="/usr/lib/jvm/java-openjdk/bin:${PATH}"</code>

</blockquote>

</blockquote>

<h4><a name="centos">CentOS 5.5</a></h4>

1949

1950

After installing

1951

<a href="http://www.centos.org/">CentOS 5.5</a>

1952

you need to make sure you have

1953

the following Development bundles installed:

1954

1955

<ul>

1956

<li>Development Libraries</li>

1957

<li>Development Tools</li>

1958

<li>Java Development</li>

1959

<li>X Software Development (Including XFree86-devel)</li>

</ul>

</blockquote>

<p>

Plus the following packages:

1964

1965

<ul>

1966

<li>cups devel: Cups Development Package</li>

1967

<li>alsa devel: Alsa Development Package</li>

1968

<li>Xi devel: libXi.so Development Package</li>

</ul>

</blockquote>

<p>

The freetype 2.3 packages don't seem to be available,

1973

but the freetype 2.3 sources can be downloaded, built,

1974

and installed easily enough from

1975

1976

the freetype site</a>.

1977

Build and install with something like:

1978

1979

<code>bash ./configure</code>

<br>

<br>

<code>sudo -u root make install</code>

1984

</blockquote>

1985

<p>

1986

Mercurial packages could not be found easily, but a Google

1987

search should find ones, and they usually include Python if

it's needed.

</blockquote>

<h4><a name="debian">Debian 5.0 (Lenny)</a></h4>

1992

1993

After installing <a href="http://debian.org">Debian</a> 5

1994

you need to install several build dependencies.

1995

The simplest way to install the build dependencies is to

1996

execute the following commands as user <code>root</code>:

1997

1998

<code>aptitude build-dep openjdk-7</code>

1999

<br>

2000

<code>aptitude install openjdk-7-jdk libmotif-dev</code>

2001

</blockquote>

2002

<p>

2003

In addition, it's necessary to set a few environment

2004

variables for the build:

2005

2006

<code>export LANG=C</code>

2007

<br>

2008

<code>export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}"</code>

</blockquote>

</blockquote>

<h4><a name="ubuntu">Ubuntu 12.04</a></h4>

Erik Joelsson

2015-04-03 08:45:08 -0700

[diff] [blame]

2013

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

2014

After installing <a href="http://ubuntu.org">Ubuntu</a> 12.04

2015

you need to install several build dependencies. The simplest

2016

way to do it is to execute the following commands:

2017

2018

<code>sudo aptitude build-dep openjdk-7</code>

2019

<br>

2020

<code>sudo aptitude install openjdk-7-jdk</code>

2021

</blockquote>

2022

<p>

2023

In addition, it's necessary to set a few environment

2024

variables for the build:

2025

2026

<code>export LANG=C</code>

2027

<br>

2028

<code>export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}"</code>

</blockquote>

</blockquote>

<h4><a name="opensuse">OpenSUSE 11.1</a></h4>

2033

2034

After installing <a href="http://opensuse.org">OpenSUSE</a> 11.1

2035

you need to install several build dependencies.

2036

The simplest way to install the build dependencies is to

2037

execute the following commands:

2038

2039

<code>sudo zypper source-install -d java-1_7_0-openjdk</code>

2040

<br>

2041

<code>sudo zypper install make</code>

2042

</blockquote>

2043

<p>

2044

In addition, it is necessary to set a few environment

2045

variables for the build:

2046

2047

<code>export LANG=C</code>

2048

<br>

2049

<code>export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:$[PATH}"</code>

2050

</blockquote>

2051

<p>

2052

Finally, you need to unset the <code>JAVA_HOME</code>

2053

environment variable:

2054

2055

<code>export -n JAVA_HOME</code>

</blockquote>

</blockquote>

<h4><a name="mandriva">Mandriva Linux One 2009 Spring</a></h4>

2060

2061

After installing <a href="http://mandriva.org">Mandriva</a>

2062

Linux One 2009 Spring

2063

you need to install several build dependencies.

2064

The simplest way to install the build dependencies is to

2065

execute the following commands as user <code>root</code>:

2066

2067

<code>urpmi java-1.7.0-openjdk-devel make gcc gcc-c++

2068

freetype-devel zip unzip libcups2-devel libxrender1-devel

2069

libalsa2-devel libstc++-static-devel libxtst6-devel

libxi-devel</code>

</blockquote>

<p>

In addition, it is necessary to set a few environment

2074

variables for the build:

2075

2076

<code>export LANG=C</code>

2077

<br>

2078

<code>export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:${PATH}"</code>

</blockquote>

</blockquote>

<h4><a name="opensolaris">OpenSolaris 2009.06</a></h4>

2083

2084

After installing <a href="http://opensolaris.org">OpenSolaris</a> 2009.06

2085

you need to install several build dependencies.

2086

The simplest way to install the build dependencies is to

2087

execute the following commands:

2088

2089

<code>pfexec pkg install SUNWgmake SUNWj7dev

2090

sunstudioexpress SUNWcups SUNWzip SUNWunzip SUNWxwhl

2091

SUNWxorg-headers SUNWaudh SUNWfreetype2</code>

2092

</blockquote>

2093

<p>

2094

In addition, it is necessary to set a few environment

2095

variables for the build:

2096

2097

<code>export LANG=C</code>

2098

<br>

2099

<code>export PATH="/opt/SunStudioExpress/bin:${PATH}"</code>

</blockquote>

</blockquote>

Kelly O'Hair

2008-04-30 19:35:26 -0700

[diff] [blame]

2103

</blockquote>

Kelly O'Hair

2013-02-23 10:47:01 -0800

[diff] [blame]

2104

2105

</blockquote>

2106

2107

2108

2109

<!-- Leave out Appendix D --

2110

2111

<hr>

2112

<h2><a name="mapping">Appendix D: Mapping Old to New</a></h2>

2113

2114

<p>This table will help you convert some idioms of the old build

2115

system to the new build system.</p>

2116

2117

2118

<th>In the old build system, you used to...</th>

2119

<th>In the new build system, you should ...</th>

2120

</tr>

2121

2122

<td>run <code>make sanity</code></td>

2123

<td>run <code>bash ./configure</code></td>

2124

</tr>

2125

2126

<td>set <code>ALT_OUTPUTDIR=build/my-special-output</code></td>

2127

<td>before building the first time:

Kelly O'Hair

2011-03-22 08:15:39 -0700

[diff] [blame]

2128

<br>

Kelly O'Hair