Draft of restarted "OpenJDK Developers' Guide" available for discussion

[Joe Darcy]

Joe Darcy wrote:
> Joe Darcy wrote:
>> Hello.
>>
>> After receiving some off-list feedback and some additional 
>> self-editing, I considering making the following changes in the next 
>> draft:
>>
>
> I've posted draft 0.776 to
> http://cr.openjdk.java.net/~darcy/OpenJdkDevGuide/OpenJdkDevelopersGuide.v0.776.html 
>
>
> In addition to the previously mentioned changes, this draft changes 
> the URLs of the images and reflect various corrections and suggestions 
> from Oracle's docs team; diff below.
>
> -Joe
>

Another round of minor changes in draft 0.777:
http://cr.openjdk.java.net/~darcy/OpenJdkDevGuide/OpenJdkDevelopersGuide.v0.777.html

Diffs below.

-Joe


< <h1>OpenJDK Developers' Guide, Version 0.776</h1>
---
 > <h1>OpenJDK Developers' Guide, Version 0.777</h1>
236c236,237
< alt="Compatibility Axes" title="Compatibility Axes"/>
---
 >   alt="Compatibility Axes"
 > title="Compatibility Axes"/>
299c300,301

< alt="Maintenance and Update Release Compatibility"/>
---
 >   alt="Maintenance and Update Release Compatibility"
 > title="Maintenance and Update Release Compatibility"/>
361c363,364
< alt="Platform Release Compatibility" title="Platform Release 
Compatibility"/>
---
 >   alt="Platform Release Compatibility"
 > title="Platform Release Compatibility"/>
582,583c585,586
< compatibility repercussions, but only a few of kinds of changes will
< be analyzed below.
---
 > compatibility repercussions, but only a few kinds of changes will be
 > analyzed below.
633c636
< when keywords were added (<tt><a
---
 > when keywords were added (<code><a
635c638
< title="JLSv3 &sect;8.1.1.3 &ndash; strictfp 
Classes">strictfp</a></tt>, <tt><a
---
 > title="JLSv3 &sect;8.1.1.3 &ndash; strictfp 
Classes">strictfp</a></code>, <code><a
637c640
< Assertion Facility">assert</a></tt>, and <tt><a
---
 > Assertion Facility">assert</a></code>, and <code><a
640c643
< Enhanced for loops and Static Import">enum</a></tt>).
---
 > Enhanced for loops and Static Import">enum</a></code>).
691c694
< <tt>javac</tt>:
---
 > <code>javac</code>:
713,714c716,717
< reuse "<tt>String</tt>", "<tt>Object</tt>", and other names of core
< classes from packages like <tt>java.lang</tt> and <tt>java.util</tt>
---
 > reuse "<code>String</code>", "<code>Object</code>", and other names 
of core
 > classes from packages like <code>java.lang</code> and 
<code>java.util</code>
1034c1037,1038
< alt="Source compatibility levels of FQN programs"/>
---
 >   alt="Source compatibility levels"
 > title="Source compatibility levels"/>
1115c1119
< title="Java SE 6 Specification for 
AbstractMethodError"><tt>AbstractMethodError</tt></a> is thrown; if
---
 > title="Java SE 6 Specification for 
AbstractMethodError"><code>AbstractMethodError</code></a> is thrown; if
1148c1152
< defining a proper <tt>equals</tt> method in a class can be nontrivial.
---
 > defining a proper <code>equals</code> method in a class can be 
nontrivial.
1164c1168
< structure of libraries, such as adding new <tt>public</tt> methods, is
---
 > structure of libraries, such as adding new <code>public</code> 
methods, is
1168c1172
< up the set of <tt>public</tt> methods on a library class and throw an
---
 > up the set of <code>public</code> methods on a library class and throw an
1192c1196
< included in its specification; for <tt>final</tt> classes this
---
 > included in its specification; for <code>final</code> classes this
1263c1267
< a maintenance release, and only questionable for an update release.
---
 > a maintenance release, and questionable for an update release.
1329c1333
< Compared to the first reason, the second season:</p>
---
 > Compared to the first season, the second season:</p>
1332c1336
< <li><p>Deletes yeoman <tt>JANICE_RAND</tt>
---
 > <li><p>Deletes yeoman <code>JANICE_RAND</code>
1335c1339
< <li><p>Adds <tt>PAVEL_CHEKOV</tt>
---
 > <li><p>Adds <code>PAVEL_CHEKOV</code>
1353c1357
< <li><p>Deleting <tt>JANICE_RAND</tt> is source incompatible, able to break
---
 > <li><p>Deleting <code>JANICE_RAND</code> is source incompatible, able 
to break
1358c1362
< methods on the enum, including <tt>values</tt> and <tt>valueOf</tt>.
---
 > methods on the enum, including <code>values</code> and 
<code>valueOf</code>.
1369c1373
< <li><p>Adding <tt>PAVEL_CHEKOV</tt> is binary-preserving source 
compatible.
---
 > <li><p>Adding <code>PAVEL_CHEKOV</code> is binary-preserving source 
compatible.
1393c1397
< <tt>compareTo</tt>.
---
 > <code>compareTo</code>.
1538c1542
< For this particular method, the specification also include information
---
 > For this particular method, the specification also includes information
1692,1693c1696,1697
< In particular, new JDK-internal interfaces should not expected to be
< usable from outside of the JDK.
---
 > In particular, new JDK-internal interfaces should <em>not</em> be
 > expected to be usable from outside of the JDK.
1871,1874c1875,1885
< platform specific code if you must.  Prefer writing solutions to
< problems in the JDK in the Java language compared to other languages,
< C, C++, shell, and so on; these preferences extend to writing
< regression tests.</p>
---
 > platform specific code if you must.
 >
 > Prefer writing solutions to problems in the JDK in the Java language
 > compared to other languages, C, C++, shell, and so on; these
 > preferences extend to writing regression tests.
 >
 > Note that for C and C++ code, the sources must compile successfully
 > under many different compilers, making cross-platform building and
 > testing especially important.
 >
 > </p>
1949,1950c1960,1961
< While revewing patch files is adaquate for small changes, larger
< changes are often facilated by use of <a
---
 > While reviewing patch files is adequate for small changes, larger
 > changes are often facilitated by use of <a
2013c2024
< Using a paired <code>@derepcated</code> javadoc tag for informative
---
 > Using a paired <code>@deprecated</code> javadoc tag for informative
2026a2038,2039
 > <li> Table of figures
 >
2030a2044
 > <li> Extra coding guidelines for C/C++ code