On Wed, 16 Nov 2022 16:17:48 GMT, Stefan Karlsson <stef...@openjdk.org> wrote:
>> The sorted blocks of includes have deteriorated to the point that I felt >> compelled to clean up some of the issues. >> >> *EDIT*: The below discussion has been deferred out of this PR. Now this only >> deals with fixing the placement and sorting of includes, plus some >> surrounding blank lines. >> >> 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, so I don't think that's a good >> enough argument, again IMHO. 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. >> >> While going over the include headers I've also cleaned up surrounding >> whitespaces and incorrect include guards. > > Stefan Karlsson has updated the pull request with a new target base due to a > merge or a rebase. The pull request now contains three commits: > > - Cleanups > - Merge remote-tracking branch 'upstream/master' into > various_include_order_fixes > - Various include order fixes Looks good and is an improvement. About the removed comments after includes, I am sometimes guilty of this to mark includes that came just for one specific little thing - the implied hope is that disentangling includes and removing unnecessary ones periodically is easier that way. However, this never worked. I wish we had an automatic include "GC" process to reduce the includes, like Ioi sometimes does manually. ------------- Marked as reviewed by stuefe (Reviewer). PR: https://git.openjdk.org/jdk/pull/11108
