RFR: 8296926: Use proper include lines for files in include/

Kim Barrett kbarrett at openjdk.org
Mon Nov 14 12:14:29 UTC 2022


On Mon, 14 Nov 2022 09:25:11 GMT, Stefan Karlsson <stefank at openjdk.org> wrote:

> One of the more prevalent issues is that files in src/hotspot/share/include are not properly sorted. There has been some discussion that that was done on purpose, but it just adds another exception to the include rules that don't have any practical purposes, IMHO. It also goes against our written style guide around include files. One argument why it was OK have the files in include/ pushed up to the top of the sorted block, was that the file was included without specifying a directory. That's an argument that contradicts how we treat platform-dependent files, which (unfortunately) often also are specified without a prefixed directory. To remove this special case, I've removed the extraneous make file entry to have src/hotspot/share/include in the set of directories to search for headers when compiling HotSpot. Now all the header files in src/hotspot/share/include gets included by specifying the path from src/hotspot/share, just like the other platform-independent headers in HotSpot
 .
> 
> This RFE splits out the 'include/' changes from #11108 / JDK-8296886, so that those changes can be discussed separately.

This looks fine to me.

Since the headers in the include/ directory are the interface exposed by HotSpot to the rest of the JDK, perhaps a better name might have been "hotspot" or "hotspot_api" or something like that.  OTOH, the clients in the rest of the JDK include them without a directory, so the directory name doesn't matter to them.  I'm fine with the existing name.

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

Marked as reviewed by kbarrett (Reviewer).

PR: https://git.openjdk.org/jdk/pull/11133



More information about the build-dev mailing list