Skip to content

Use quotes for local project header includes - #21

Merged
mkoncek merged 2 commits into
fedora-java:mainfrom
mizdebsk:pr/21
Aug 21, 2025
Merged

Use quotes for local project header includes#21
mkoncek merged 2 commits into
fedora-java:mainfrom
mizdebsk:pr/21

Conversation

@mizdebsk

@mizdebsk mizdebsk commented Jul 22, 2025

Copy link
Copy Markdown
Member

Replace angle brackets <...> with quotes "..." for project headers to improve compatibility with IDEs and tooling.

While both forms are valid, many tools and IDEs treat quoted includes as local files, enabling better indexing, navigation, and refactoring support.

Since headers are now included with "..." and reside in the same or subdirectories, the -Isrc include path is no longer necessary.

mizdebsk added 2 commits July 22, 2025 12:43
Replace angle brackets <...> with quotes "..." for project headers
to improve compatibility with IDEs and tooling.

While both forms are valid, many tools and IDEs treat quoted includes
as local files, enabling better indexing, navigation, and refactoring
support.
Follow up to switching from angle brackets to quoted includes for
local headers.  Since headers are now included with "..." and reside
in the same or subdirectories, the -Isrc include path is no longer
necessary.
@mkoncek

mkoncek commented Jul 23, 2025

Copy link
Copy Markdown
Member

For simple projects like this it of course works. I first noticed that the OpenJDK's codebase uses this style and I started to like it.
Though in a complex project, it is almost necessary to put custom header files in a directory having the project name, like #include <project/header.hpp> which is not done here and is unnecessary.
So I will probably accept this.

@mizdebsk

Copy link
Copy Markdown
Member Author

Is there anything else expected from me in this PR so that it can be accepted?

@mkoncek
mkoncek merged commit 002c039 into fedora-java:main Aug 21, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants