Skip to content

8352645: Add tool support to check order of includes #24247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed

8352645: Add tool support to check order of includes #24247

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a76d4f9
do not reorder certain includes
dougxc Mar 25, 2025
d4d367a
added tool to sort includes
dougxc Mar 26, 2025
6277947
sort includes in subset of HotSpot sources and added a test to keep t…
dougxc Mar 26, 2025
18e2a1d
drop extra blank lines and preserve rule for first include in .inline…
dougxc Mar 26, 2025
807374e
update style guide with advice on how to label includes that should n…
dougxc Mar 27, 2025
da06409
removed extra blank lines
dougxc Mar 27, 2025
632ed38
moved some logic out of SortIncludes into TestIncludesAreSorted
dougxc Mar 27, 2025
cada0df
allow spaces between `#` and `include`
dougxc Mar 27, 2025
3819f86
remove trailing spaces
dougxc Mar 27, 2025
93770e7
moved test/hotspot/jtreg/sources into tier1_common
dougxc Mar 27, 2025
c93e664
moved error message into UnsortedIncludesException
dougxc Mar 27, 2025
921e325
convert Windows path to Unix path
dougxc Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions test/hotspot/jtreg/TEST.groups
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ serviceability_ttf_virtual = \
-serviceability/jvmti/negative

tier1_common = \
sources \
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand this change. How does this end up doing anything different than before?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes sources be tested in GHA:

jdk/.github/workflows/test.yml

Line 88 in a1ab1d8

test-suite: 'test/hotspot/jtreg/:tier1_common'

An alternative would be to add a separate GHA jobs just for sources:

          - test-name: 'hs/tier1 sources'
            test-suite: 'test/hotspot/jtreg/:tier1_sources'
            debug-suffix: -debug

Given how small sources is (currently only 1 test), it felt like it should just be folded into common.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, the workflows definition is what I was having trouble finding. I
understand now. In light of that, the proposed change to the groups looks
fine.

sanity/BasicVMTest.java \
gtest/GTestWrapper.java \
gtest/LockStackGtests.java \
Expand Down Expand Up @@ -619,16 +620,12 @@ tier1_serviceability = \
-serviceability/sa/TestJmapCore.java \
-serviceability/sa/TestJmapCoreMetaspace.java

tier1_sources = \
sources

tier1 = \
:tier1_common \
:tier1_compiler \
:tier1_gc \
:tier1_runtime \
:tier1_serviceability \
:tier1_sources

tier2 = \
:hotspot_tier2_runtime \
Expand Down
4 changes: 2 additions & 2 deletions test/hotspot/jtreg/sources/TestIncludesAreSorted.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ public static void main(String[] ignore) throws IOException {
%d files with unsorted headers found:

%s

This should be fixable by running:

java %s.java --update %s


Expand Down