Call for Discussion: New Project: Developer's Guide

[Jiva, Azeem]

Jesper,

  Amazon is willing to help with a hotspot debug guide as well as participating in hotspot related documentation.





Hi.



I would like to discuss the possible creation of the Developer's Guide Project

with myself, Jesper Wilhelmsson, as the lead and the Core-Libs, Compiler, and

Hotspot groups as the sponsoring Groups.



The initial goal of the project would be to create up-to-date guidelines for

OpenJDK development and contributions. The intent is to update the existing

OpenJDK Developer's Guide [1] which hasn't been updated since 2012. Parts of

the existing guide are in need of updates while other parts are yet to be

written. The initial source code for this project will be based on the current

OpenJDK Developer's Guide.



In more recent years some process related information has been published on the

OpenJDK wiki [2], but this information was never reviewed or approved by the

community. Even though large parts of this information may be accurate, it needs

to go through proper review before it can be seen as official guidelines for

OpenJDK development.



Once the initial goal has been reached the project will transition into a

maintenance project to keep the OpenJDK Developer's Guide up to date.



The OpenJDK Developer's Guide is intended to contain tutorial style texts that

give examples and step-by-step directions for common parts of the development

process. Strict rules for OpenJDK development are better suited to a process

JEP. The development of such a JEP is outside of the scope of this project but

will be developed as part of a separate effort in parallel.



Initial committers of the Developer's Guide Project include Mark Reinhold, Iris

Clark, and Jesper Wilhelmsson. Additional committers may be identified through

this discussion.



The project will host at least one mailing list, guide-dev at openjdk.java.net<https://mail.openjdk.java.net/mailman/listinfo/discuss>,

for discussions and reviews of changes.



Thanks,

/Jesper



[1] http://openjdk.java.net/guide/

[2] https://wiki.openjdk.java.net/


--
Azeem Jiva