-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Fixed #14266 (documentation: clarify how -i works) #7961
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
Conversation
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.
Pull Request Overview
This PR clarifies the documentation for the -i command-line option to better explain when and how it filters files. The key clarification is that -i only filters translation units based on their source filename before preprocessing begins, and does not apply to headers included during preprocessing.
Key Changes:
- Updated the manual section title from "Excluding a file or folder from checking" to "Exclude files matching a given pattern"
- Clarified that filtering happens on source filenames before preprocessing, not during preprocessing or analysis
- Added explicit notes directing users to use
--suppressfor filtering warnings in headers - Updated command-line help text to use more precise terminology ("translation units", "source filename")
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| man/manual.md | Updated section heading and expanded explanation of -i option behavior, emphasizing that filtering happens before preprocessing and only applies to source files |
| cli/cmdlineparser.cpp | Revised help text for -i option to clarify it skips translation units based on source filename and recommends suppressions for header warnings |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
|



No description provided.