0N/A<!
DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
0N/A<
title>Doc Process Notes</
title>
0N/A<
meta http-
equiv="Content-Type" content="text/html; charset=iso-8859-1">
0N/A<
h3><
a name="REGEXP"></
a><
br>
0N/A<
p> REGEXP is a list of wildcard patterns that determines which packages listed
0N/A was motivated by the need to divide the world into "core packages"
0N/A (java.*) and "extension packages" (javax.*). In time, the distinction
0N/A went away. The whole table is now called "Platform Packages"--which
0N/A eliminated the need for this list of regular expressions. But it lingered on,
0N/A accreting all of the packages in the JVM, one by one. I pruned it back to "*",
0N/A so it now covers every package in the Java platform API docs. If some separation
0N/A is needed in the future, it can grow back into a colon-separated list, starting
0N/A with this, which is in all respects equivalent to "*" at this point
0N/A<
h3><
a name="releaseTargets"></
a><
br>
0N/A Release Targets</
h3>
0N/A<
p> (Thanks to Kelly O'Hair for this info.)</
p>
0N/A<
p> The <
tt>rel-coredocs</
tt> and <
tt>rel-docs</
tt> targets were added by Eric
0N/A Armstrong. <
tt>rel-coredocs</
tt> assumes the kind of large, 32-bit machine used
0N/A in the javapubs group's docs-release process. It specifies memory settings accordingly
0N/A to maximize performance.</
p>
0N/A<
p> The performance settings, like the sanity check, are most important for the
0N/A core docs--the platform APIs. Running javadoc on those APIs takes a significant
0N/A amount of time and memory. Setting the initial heap size as large as possible
0N/A is important to prevent thrashing as the heap grows. Setting the maximum as
0N/A large as necessary is also important to keep the job from failing.</
p>
0N/A <
p> <
tt>-J-Xmx512</
tt> sets a maximum of 512, which became necessary in 6.0<
br>
0N/A <
tt>-J-Xms256</
tt> sets starting size to 256 (default is 8)</
p>
0N/A<
p> <
tt>rel-coredocs</
tt> also includes a sanity check to help ensure that <
tt>BUILD_NUMBER</
tt>
0N/A and <
tt>MILESTONE</
tt> are specified properly when docs are built outside of
0N/A the normal release engineering process, with the intention of releasing them
on the web or in a downloaded docs bundle. (When invoked in release engineering's
control build, the values are always set properly. But when the targets are
run by themselves, they default to b00 and "internal"--which silently
sabotage the result of a build that can take many hours to complete.</
p>