Skip to content

Makefile.common: add -Wundef #233

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

Merged
merged 1 commit into from
Jun 6, 2025
Merged

Makefile.common: add -Wundef #233

merged 1 commit into from
Jun 6, 2025

Conversation

anglov
Copy link
Member

@anglov anglov commented Jun 6, 2025

Description

There are some useful warning flags, which are enabled in internal projects, like -Wundef and -Wshadow.

This commit adding -Wundef to our build system

Motivation and Context

Enable -Wundef

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (refactoring, style fixes, git/CI config, submodule management, no code logic changes)

How Has This Been Tested?

  • Already covered by automatic testing.
  • New test added: (add PR link here).
  • Tested by hand on: (list targets here).

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing linter checks and tests passed.
  • My changes generate no new compilation warnings for any of the targets.

Special treatment

  • This PR needs additional PRs to work (list the PRs, preferably in merge-order).
  • I will merge this PR by myself when appropriate.

Copy link

@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.

Hello @anglov, 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!

Summary of Changes

Hello! gemini-code-assist here, providing a summary of this pull request to help everyone quickly understand the changes and current status.

The primary goal of this PR, as indicated by the title and description, is to enhance the build system's warning level by adding the -Wundef compiler flag to both C and C++ compilation options. This flag helps catch potential issues where undefined preprocessor macros are used, promoting better code quality and preventing subtle bugs.

The changes are focused on the Makefile.common file, specifically modifying the CFLAGS and CXXFLAGS variables to include the new warning flag. This is a straightforward change aimed at improving code hygiene across the project.

Highlights

  • Add -Wundef compiler flag: The core change is the addition of the -Wundef flag to both CFLAGS and CXXFLAGS in Makefile.common. This flag warns about the use of undefined identifiers in #if directives, which can lead to unexpected behavior.
  • Improve code quality: By enabling -Wundef, the build process will now catch potential issues related to undefined preprocessor macros, aligning with practices used in internal projects and contributing to overall code robustness.

Changelog

  • Makefile.common
    • Added -Wundef flag to CFLAGS and CXXFLAGS to enable warnings for undefined preprocessor macros.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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

@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

The pull request introduces the -Wundef flag to the CFLAGS and CXXFLAGS in the Makefile.common. This is a good step towards enabling more useful warning flags. The change is straightforward and seems well-motivated. Here are some comments.

Merge Readiness

The addition of -Wundef is a positive step towards improving code quality by enabling more compiler warnings. The change is simple and well-motivated. I am unable to approve the pull request, and users should have others review and approve this code before merging. There are no critical or high severity issues, so this pull request is ready to be merged.

Copy link

github-actions bot commented Jun 6, 2025

Unit Test Results

8 030 tests  +72   7 506 ✅ +72   40m 59s ⏱️ +27s
  479 suites + 9     524 💤 ± 0 
    1 files   ± 0       0 ❌ ± 0 

Results for commit 9d536e5. ± Comparison against base commit e630102.

@anglov anglov marked this pull request as ready for review June 6, 2025 13:04
@anglov anglov merged commit 69ab137 into master Jun 6, 2025
38 checks passed
@anglov anglov deleted the anglov/wundef branch June 6, 2025 13:05
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