1berry/openjdk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

8323158: HotSpot Style Guide should specify more include ordering

Browse Source 
Reviewed-by: kbarrett, stuefe, dholmes, kvn
This commit is contained in:
Stefan Karlsson 2025-03-06 07:42:16 +00:00
parent 5c552a9d64
commit 649ef77951
2 changed files with 39 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/hotspot-style.html
View File

@ -207,23 +207,31 @@ the simple "getter".</p></li>
<ul> <ul>
<li><p>All source files must have a globally unique basename. The build <li><p>All source files must have a globally unique basename. The build
system depends on this uniqueness.</p></li> system depends on this uniqueness.</p></li>
<li><p>Keep the include lines within a section alphabetically sorted.</p></li>
<li><p>Put conditional inclusions (`#if ...`) at the end of the section of HotSpot
include lines. This also applies to macro-expanded includes of platform
dependent files.</p></li>
<li><p>Put system includes in a section after the HotSpot include lines with a blank
line separating the two sections.</p></li>
<li><p>Do not put non-trivial function implementations in .hpp files. If <li><p>Do not put non-trivial function implementations in .hpp files. If
the implementation depends on other .hpp files, put it in a .cpp or a the implementation depends on other .hpp files, put it in a .cpp or
.inline.hpp file.</p></li> a .inline.hpp file.</p></li>
<li><p>.inline.hpp files should only be included in .cpp or .inline.hpp <li><p>.inline.hpp files should only be included in .cpp or .inline.hpp
files.</p></li> files.</p></li>
<li><p>All .inline.hpp files should include their corresponding .hpp <li><p>All .inline.hpp files should include their corresponding .hpp file as
file as the first include line. Declarations needed by other files the first include line with a blank line separating it from the rest of the
should be put in the .hpp file, and not in the .inline.hpp file. This include lines. Declarations needed by other files should be put in the .hpp
rule exists to resolve problems with circular dependencies between file, and not in the .inline.hpp file. This rule exists to resolve problems
.inline.hpp files.</p></li> with circular dependencies between .inline.hpp files.</p></li>
<li><p>Do not include a .hpp file if the corresponding .inline.hpp file is included.</p></li>
<li><p>Use include guards for .hpp and .inline.hpp files. The name of the defined
guard should be derived from the full search path of the file relative to the
hotspot source directory. The guard should be all upper case with all paths
separators and periods replaced by underscores.</p></li>
<li><p>Some build configurations use precompiled headers to speed up the <li><p>Some build configurations use precompiled headers to speed up the
build times. The precompiled headers are included in the precompiled.hpp build times. The precompiled headers are included in the precompiled.hpp
file. Note that precompiled.hpp is just a build time optimization, so file. Note that precompiled.hpp is just a build time optimization, so
don't rely on it to resolve include problems.</p></li> don't rely on it to resolve include problems.</p></li>
<li><p>Keep the include lines alphabetically sorted.</p></li>
<li><p>Put conditional inclusions (<code>#if ...</code>) at the end of
the include list.</p></li>
</ul> </ul>
<h3 id="jtreg-tests">JTReg Tests</h3> <h3 id="jtreg-tests">JTReg Tests</h3>
<ul> <ul>

29
doc/hotspot-style.md
View File

@ -135,9 +135,18 @@ change should be done with a "setter" accessor matched to the simple
### Source Files ### Source Files
* All source files must have a globally unique basename. The build * All source files must have a globally unique basename. The build
system depends on this uniqueness. system depends on this uniqueness.
* Keep the include lines within a section alphabetically sorted.
* Put conditional inclusions (`#if ...`) at the end of the section of HotSpot
include lines. This also applies to macro-expanded includes of platform
dependent files.
* Put system includes in a section after the HotSpot include lines with a blank
line separating the two sections.
* Do not put non-trivial function implementations in .hpp files. If * Do not put non-trivial function implementations in .hpp files. If
the implementation depends on other .hpp files, put it in a .cpp or the implementation depends on other .hpp files, put it in a .cpp or
a .inline.hpp file. a .inline.hpp file.
@ -146,19 +155,23 @@ a .inline.hpp file.
files. files.
* All .inline.hpp files should include their corresponding .hpp file as * All .inline.hpp files should include their corresponding .hpp file as
the first include line. Declarations needed by other files should be put the first include line with a blank line separating it from the rest of the
in the .hpp file, and not in the .inline.hpp file. This rule exists to include lines. Declarations needed by other files should be put in the .hpp
resolve problems with circular dependencies between .inline.hpp files. file, and not in the .inline.hpp file. This rule exists to resolve problems
with circular dependencies between .inline.hpp files.
* Do not include a .hpp file if the corresponding .inline.hpp file is included.
* Use include guards for .hpp and .inline.hpp files. The name of the defined
guard should be derived from the full search path of the file relative to the
hotspot source directory. The guard should be all upper case with all paths
separators and periods replaced by underscores.
* Some build configurations use precompiled headers to speed up the * Some build configurations use precompiled headers to speed up the
build times. The precompiled headers are included in the precompiled.hpp build times. The precompiled headers are included in the precompiled.hpp
file. Note that precompiled.hpp is just a build time optimization, so file. Note that precompiled.hpp is just a build time optimization, so
don't rely on it to resolve include problems. don't rely on it to resolve include problems.
* Keep the include lines alphabetically sorted.
* Put conditional inclusions (`#if ...`) at the end of the include list.
### JTReg Tests ### JTReg Tests
* JTReg tests should have meaningful names. * JTReg tests should have meaningful names.