Where to put supplementary docs?

[Andrew Haley]

On 4/29/25 14:19, Mark Reinhold wrote:

> Andrew -- Your initial message talked about “supporting documents to
> justify a change,” which is broad and of concern.  The example you gave,
> of the HotSpot subtype-checking algorithm, might have been created in
> support of a specific change but it clearly falls into the narrower
> category of “reference documentation for JDK internals.”  Are you
> content with using that narrower category for this new documentation
> directory?

Yes.

For example, the document that provoked my question is a mathematical 
correctness proof of an algorithm used in HotSpot. The proof is 
essential to the understanding of the code. Mathematics cannot be 
expressed clearly in markdown because markdown does not support the 
symbols used. We should allow any reasonable type of document.

-- 
Andrew Haley  (he/him)
Java Platform Lead Engineer
Red Hat UK Ltd. <https://www.redhat.com>
https://keybase.io/andrewhaley
EAC8 43EB D3EF DB98 CC77 2FAD A5CD 6035 332F A671