Proposal to update build documentation
Erik Joelsson
erik.joelsson at oracle.com
Tue Apr 8 08:21:26 UTC 2014
Build documentation is certainly in need of a lot of love. I'm sure
Magnus will have something to add to this, but from me I very much
welcome this initiative.
/Erik
On 2014-04-08 09:40, Martijn Verburg wrote:
> Hi all,
>
> The Adoption Group is about to embark on it's migration of all of its
> documentation on building OpenJDK (adoptopenjdk.java.net contains a bunch
> of pages). We found your group page at
> http://openjdk.java.net/groups/build/and wiki at
> https://wiki.openjdk.java.net/display/Build/Main and figured our
> documentation should really fall under your gropup's banner (we can
> reference it from the Adoption Group for new comers).
>
> So our proposal is to:
>
> 1.) Compare the docs that we have vs what's contained in the various
> README-builds.html files
> 2.) Send in patches to README-builds.html where appropriate
> 3.) Only document temporary workarounds / known issues etc in the Build
> group's wiki
>
> And the one I was more uncertain about:
>
> * Document uncommon build scenarios Build group's wiki, e.g. What certain
> unusual flags mean and so forth.
>
> Does this sound reasonable? I'm happy to walk through the existing
> documentation set that we have with someone so you have a clear idea on
> what we're proposing to bring across.
>
> Cheers,
> Martijn
More information about the build-dev
mailing list