Skip to content
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.

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

Release exported headers to include/aiebu #76

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

stsoe
Copy link
Collaborator

@stsoe stsoe commented Mar 3, 2025

Exported API header files are released to include/aiebu/*.h and are to be included using #include <aiebu/zzz.h>.

This allows aiebu headers to be installed under a shared include directory within polluting top-level include. This is similar to how XRT headers and many other project headers are installed.

Fix implementation to prefix public exported header include with aiebu/. Adjust include search path for implementation code.

End-user applications should adjust include search path as well but for the time being wrapper headers are released to legacy location while redirecting to new location with a warning.

Fix implementaton to prefix public exported header include with `aiebu/`.
Adjust include search path for implementation code.

End-user applications should adjust include search path as well but
for the time being exported headers remain in legacy locations and
are released to legacy location as well.

Signed-off-by: Soren Soe <2106410+stsoe@users.noreply.github.com>
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

clang-tidy made some suggestions

@@ -1,4 +1,4 @@
// SPDX-License-Identifier: MIT
// Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
#pragma message("please replace src/cpp/aiebu/src/include/aiebu.h with src/cpp/include/aiebu/aiebu.h")
#pragma message("Please replace inclusion of include/aiebu.h with include/aiebu/aiebu.h")
Copy link

Choose a reason for hiding this comment

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

warning: Please replace inclusion of include/aiebu.h with include/aiebu/aiebu.h [clang-diagnostic-#pragma-messages]

#pragma message("Please replace inclusion of include/aiebu.h with include/aiebu/aiebu.h")
        ^

@@ -1,4 +1,4 @@
// SPDX-License-Identifier: MIT
// Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
#pragma message("please replace src/cpp/aiebu/src/include/aiebu_assembler.h with src/cpp/include/aiebu/aiebu_assembler.h")
#pragma message("Please replace inclusion of include/aiebu_assembler.h with include/aiebu/aiebu_assembler.h")
Copy link

Choose a reason for hiding this comment

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

warning: Please replace inclusion of include/aiebu_assembler.h with include/aiebu/aiebu_assembler.h [clang-diagnostic-#pragma-messages]

#pragma message("Please replace inclusion of include/aiebu_assembler.h with include/aiebu/aiebu_assembler.h")
        ^

@@ -1,4 +1,4 @@
// SPDX-License-Identifier: MIT
// Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
#pragma message("please replace src/cpp/aiebu/src/include/aiebu_error.h with src/cpp/include/aiebu/aiebu_error.h")
#pragma message("Please replace inclusion of include/aiebu_error.h with include/aiebu/aiebu_error.h")
Copy link

Choose a reason for hiding this comment

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

warning: Please replace inclusion of include/aiebu_error.h with include/aiebu/aiebu_error.h [clang-diagnostic-#pragma-messages]

#pragma message("Please replace inclusion of include/aiebu_error.h with include/aiebu/aiebu_error.h")
        ^

@@ -0,0 +1,4 @@
// SPDX-License-Identifier: MIT
// Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
#pragma message("Please replace inclusion of aiebu.h with aiebu/aiebu.h")
Copy link

Choose a reason for hiding this comment

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

warning: Please replace inclusion of aiebu.h with aiebu/aiebu.h [clang-diagnostic-#pragma-messages]

#pragma message("Please replace inclusion of aiebu.h with aiebu/aiebu.h")
        ^

@@ -0,0 +1,4 @@
// SPDX-License-Identifier: MIT
// Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
#pragma message("Please replace inclusion of aiebu_assembler.h with aiebu/aiebu_assembler.h")
Copy link

Choose a reason for hiding this comment

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

warning: Please replace inclusion of aiebu_assembler.h with aiebu/aiebu_assembler.h [clang-diagnostic-#pragma-messages]

#pragma message("Please replace inclusion of aiebu_assembler.h with aiebu/aiebu_assembler.h")
        ^

@@ -0,0 +1,4 @@
// SPDX-License-Identifier: MIT
// Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
#pragma message("Please replace inclusion of aiebu_error.h with aiebu/aiebu_error.h")
Copy link

Choose a reason for hiding this comment

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

warning: Please replace inclusion of aiebu_error.h with aiebu/aiebu_error.h [clang-diagnostic-#pragma-messages]

#pragma message("Please replace inclusion of aiebu_error.h with aiebu/aiebu_error.h")
        ^

@stsoe stsoe merged commit 5390c67 into Xilinx:main-ge Mar 4, 2025
4 checks passed
@stsoe stsoe deleted the fix_includes branch March 4, 2025 16:27
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.

1 participant