Add mruby/ to the public header file path for mrbgems - #6671
Conversation
Commit f81cadf identifies this as a local header file, but it is actually externally exposed. This means it is included in the output of `mruby-config --cflags` and is therefore accessible to projects linking with pre-built libmruby. To avoid conflicts with other projects, we add `mruby/` as a directory prefix.
Summary of ChangesHello @dearblue, 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 addresses a potential issue where mrbgems' public header files could cause conflicts with other projects due to their inclusion in Highlights
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.
Code Review
This pull request correctly refactors the public header include paths for several mrbgems by adding an mruby/ prefix, which is an excellent practice for avoiding naming conflicts in larger projects. The changes are consistent across the modified files. I have added a couple of minor suggestions to improve header include consistency for better long-term maintainability.
| #include <mruby/ext/io.h> | ||
| #include "socket_hal.h" | ||
| #include <mruby/socket_hal.h> |
There was a problem hiding this comment.
For consistency with other files in the project, it's good practice to group all project-specific headers together. The blank line at line 40 separates these includes from the main block of mruby headers above. Consider removing the blank line and grouping all mruby headers together to improve readability and maintainability.
| #include <mruby/task.h> | ||
| #include <mruby/task_hal.h> |
There was a problem hiding this comment.
For consistency with other files in this project and general best practices, it's recommended to group all project-specific headers together. These mruby/ headers are currently separated from the main block of mruby headers by standard library includes. Consider moving them up to be with the other mruby headers (before line 19) to improve readability and maintainability.
|
By c521d83, header files under |
Commit f81cadf identifies this as a local header file, but it is actually externally exposed. This means it is included in the output of
mruby-config --cflagsand is therefore accessible to projects linking with pre-built libmruby.To avoid conflicts with other projects, we add
mruby/as a directory prefix.