docs: Improve documentation for ABSL_FLAGS_STRIP_NAMES macro #1995
+52
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Addresses issue abseil#1875: Add comprehensive documentation explaining the behavior of ABSL_FLAGS_STRIP_NAMES on mobile platforms. This macro's name is misleading. While it refers to stripping string literals, its actual effect is to DISABLE flag registration entirely, preventing absl::ParseCommandLine() from working. Changes: - Expanded config.h comments with detailed explanation of the macro's real effect on flag registration (true disables registration, false enables it) - Added information about mobile platform defaults (Android, iOS, embedded) - Included practical examples for users who need flags on mobile platforms - Added comments to flag.h explaining the FlagRegistrar do_register parameter This will help users (especially those porting code to iOS/Android) understand why their flags mysteriously don't work and how to fix it.
4 tasks
Author
|
@derekmauro can review the changes , Which closes the issue #1875 Thank You! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive documentation for
ABSL_FLAGS_STRIP_NAMESto clarify itsactual behavior on mobile platforms. This addresses confusion about why flags
mysteriously don't work on iOS and Android.
Issue
Closes #1875
Problem
The macro name
ABSL_FLAGS_STRIP_NAMESis misleading:absl::ParseCommandLine()fails silentlySolution
Enhanced documentation in two files:
Changes in
absl/flags/config.hbazel build --define=ABSL_FLAGS_STRIP_NAMES=0cmake -DABSL_FLAGS_STRIP_NAMES=0g++ -DABSL_FLAGS_STRIP_NAMES=0Changes in
absl/flags/flag.hdo_registerparameterdo_register=falsedisables registration (happens when STRIP_NAMES=1)Testing
Related
Checklist