Skip to content

Conversation

@std-microblock
Copy link
Contributor

  • 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消息,不要用中文,请用英文描述。

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 ia32-doc package within the xmake build system. It provides a flexible way to integrate Intel Architecture Software Developer's Manual C/C++ headers into projects, offering various header file types and including automated testing to ensure proper functionality.

Highlights

  • New Package Definition: Added a new xmake.lua file to define the ia32-doc package, enabling its integration into projects using xmake.
  • Configurable Header Types: Implemented a configuration option (header_type) allowing users to select between different versions of the ia32-doc header files (e.g., h, hpp, compact, defines_only).
  • Installation Logic: Defined the on_install function to copy the selected header file to the appropriate installation directory.
  • Package Testing: Included an on_test function with a C++ snippet to verify the successful installation and usability of the ia32-doc package.

🧠 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
  • packages/i/ia32-doc/xmake.lua
    • Added the xmake package definition for ia32-doc.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

import("lib.detect.find_file")
local src_file = "out/" .. selected_file

os.cp(src_file, package:installdir("include/ia32.h"))
Copy link
Contributor

Choose a reason for hiding this comment

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

high

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))

Comment on lines 31 to 36
assert(package:check_cxxsnippets({test = [[
#include <ia32.h>
void test() {
CR3 reg;
}
]]}, {configs = {languages = "c++11"}}))
Copy link
Contributor

Choose a reason for hiding this comment

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

high

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"}}))

@std-microblock
Copy link
Contributor Author

req review @star-hengxing @luadebug

@Issues-translate-bot

This comment has been minimized.

description = "The header file type to use",
default = "hpp",
values = {"h", "hpp", "compact", "defines_only"}
})
Copy link
Member

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")
Copy link
Member

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

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.

3 participants