-
-
Notifications
You must be signed in to change notification settings - Fork 509
Add xmake.lua for ia32-doc package #9324
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
base: dev
Are you sure you want to change the base?
Conversation
std-microblock
commented
Feb 12, 2026
- Before adding new features and new modules, please go to issues to submit the relevant feature description first.
- Write good commit messages and use the same coding conventions as the rest of the project.
- Please commit code to dev branch and we will merge into master branch in feature
- Ensure your edited codes with four spaces instead of TAB.
- 增加新特性和新模块之前,请先到issues提交相关特性说明,经过讨论评估确认后,再进行相应的代码提交,避免做无用工作。
- 编写友好可读的提交信息,并使用与工程代码相同的代码规范,代码请用4个空格字符代替tab缩进。
- 请提交代码到dev分支,如果通过,我们会在特定时间合并到master分支上。
- 为了规范化提交日志的格式,commit消息,不要用中文,请用英文描述。
Summary of ChangesHello @std-microblock, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces comprehensive support for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a new xmake package for ia32-doc. The implementation is a good start, but there are a couple of areas for improvement. I've identified an unused import which should be removed for code cleanliness. More significantly, the current installation logic renames all header variants to ia32.h. This is confusing for users, especially when a C++ header (.hpp) is renamed to a C header extension (.h). My review includes specific suggestions to address this by preserving the original header filenames during installation and updating the test logic accordingly. These changes will make the package more intuitive and robust for users.
packages/i/ia32-doc/xmake.lua
Outdated
| import("lib.detect.find_file") | ||
| local src_file = "out/" .. selected_file | ||
|
|
||
| os.cp(src_file, package:installdir("include/ia32.h")) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The selected header is always installed as ia32.h, regardless of the header_type. This is misleading when header_type is hpp, as it renames a C++ header to have a .h extension, potentially causing confusion or compilation issues. It would be better to preserve the original filename to avoid this ambiguity. Note that this change will require a corresponding update in the on_test function.
os.cp(src_file, package:installdir("include/" .. selected_file))
packages/i/ia32-doc/xmake.lua
Outdated
| assert(package:check_cxxsnippets({test = [[ | ||
| #include <ia32.h> | ||
| void test() { | ||
| CR3 reg; | ||
| } | ||
| ]]}, {configs = {languages = "c++11"}})) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To support the proposed change in on_install which preserves the original header filename, the test logic needs to be updated to dynamically include the correct header file based on the header_type configuration.
local header_map = {
h = "ia32.h",
hpp = "ia32.hpp",
compact = "ia32_compact.h",
defines_only = "ia32_defines_only.h"
}
local selected_file = header_map[package:config("header_type")]
assert(package:check_cxxsnippets({test = string.format([[
#include <%s>
void test() {
CR3 reg;
}
]], selected_file)}, {configs = {languages = "c++11"}}))
|
req review @star-hengxing @luadebug |
This comment has been minimized.
This comment has been minimized.
| description = "The header file type to use", | ||
| default = "hpp", | ||
| values = {"h", "hpp", "compact", "defines_only"} | ||
| }) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keep single line
| set_description("C/C++ headers for Intel Architecture Software Developer's Manual") | ||
| set_license("MIT") | ||
|
|
||
| add_urls("https://github.com/ia32-doc/ia32-doc.git") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add_versions and tar url are missing