Repository navigation
fix: initialize default Usage function on NewFlagSet and Init - #518
Open
AdamMagued wants to merge 2 commits into
Open
AdamMagued wants to merge 2 commits into
AdamMagued wants to merge 2 commits into
Conversation
tomasaschan
reviewed
Oct 3, 2026
…nd Init Reflect default Usage behavior in docstrings as requested in review.
Author
|
Updated in 9c50e03: added docstrings for FlagSet.Usage, NewFlagSet, and FlagSet.Init documenting the default Usage function initialization as requested in review. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
In the Go standard library flag package, calling flag.NewFlagSet(name, errorHandling) initializes f.Usage to point to a default usage printer.
In spf13/pflag, NewFlagSet and Init leave f.Usage uninitialized (nil). Consequently, if user code or third-party libraries create a FlagSet and invoke f.Usage(), the program panics with a nil pointer dereference.
Root Cause
NewFlagSet and FlagSet.Init did not assign a default function to f.Usage. While internal methods like f.usage() had a fallback when f.Usage was nil, direct invocations of the exported f.Usage field resulted in a nil function call panic.
Solution
Verification
Fixes #253