RFR: 8352645: Add tool support to check order of includes [v2]

[Kim Barrett]

On Thu, 27 Mar 2025 08:18:58 GMT, Doug Simon <dnsimon at openjdk.org> wrote:

>> test/hotspot/jtreg/sources/SortIncludes.java line 39:
>> 
>>> 37: 
>>> 38: public class SortIncludes {
>>> 39:     private static final String INCLUDE_LINE = "^ *#include *(<[^>]+>|\"[^\"]+\") *$\\n";
>> 
>> There are files that have spaces between the `#` and `include`.  I'm kind of inclined to suggest we fix those
>> at some point (not in this PR).  But the regex here needs to allow for that possibility, and perhaps (eventually)
>> complain about such.
>
> Since there are no such cases in the files processed in this PR, I'd suggest not adding support for them. They can be fixed in follow up PRs as the relevant directories are added to `TestIncludesAreSorted.HOTSPOT_SOURCES_TO_CHECK`.

The regex needs to detect that case eventually anyway, so I think it should be done now.  Either we allow that
case, in which case the regex must match to work properly where they are present.  Or we forbid that case,
in which case the regex must match to detect future mistakes even after we've cleaned up existing usage.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/24247#discussion_r2016008497