RFR: 8323158: HotSpot Style Guide should specify more include ordering

[Kim Barrett]

On Fri, 31 Jan 2025 13:56:58 GMT, Stefan Karlsson <stefank at openjdk.org> wrote:

> The HotSpot Style Guide has a section about source files and includes. The style used for includes have mostly been introduced by scripts when includeDB was replaced, but also when various other enhancements to our includes were made. Some of the introduced styles were never written down in the style guide.
> 
> I propose a couple of changes to the HotSpot Style Guide to reflect some of these implicit styles that we have. While updating the text I also took the liberty to order the items in an order that I felt was good.
> 
> Note that JDK-8323158 contains a few more suggestions, but I've only addressed the items that I think can be accepted without much contention. Either I extract the items that have not been address into a new RFE, or I create a new RFE for this PR.
> 
> There a some small whitespace tweaks that I made so that the .md and .html had a similar layout.

Just a couple of minor wording nits.  Otherwise looks good to me.

doc/hotspot-style.md line 158:

> 156: 
> 157: * All .inline.hpp files should include their corresponding .hpp file as
> 158: the first include line with blank line separating it from the rest of the

s/with blank line/with a blank line/

doc/hotspot-style.md line 167:

> 165: * Use include guards for .hpp and .inline.hpp files. The name of the defined
> 166: guard should be derived from the full search path of the file relative to the
> 167: hotspot source directory. The define should be all upper case with all paths

s/define/guard/ ?

-------------

PR Review: https://git.openjdk.org/jdk/pull/23388#pullrequestreview-2587973246
PR Review Comment: https://git.openjdk.org/jdk/pull/23388#discussion_r1938039285
PR Review Comment: https://git.openjdk.org/jdk/pull/23388#discussion_r1938040703