Allow linker to perform deadcode elimination for programs using kingpin#365
Open
rosstimothy wants to merge 1 commit intoalecthomas:masterfrom
Open
Allow linker to perform deadcode elimination for programs using kingpin#365rosstimothy wants to merge 1 commit intoalecthomas:masterfrom
rosstimothy wants to merge 1 commit intoalecthomas:masterfrom
Conversation
This was largely inspired by spf13/cobra#1956. The usage rendering relied on text/template which in turn relied on reflect.MethodByName. As a result, Go's deadcode elimination is prevented from running, and thus means any downstream consumers of kingpin also cannot take advantage of deadcode elimination. This changes the usage rendering of kingpin such that text/template is not used by default. The existing templates were converted into pure Go functions, and an extensive test suite was added to ensure equality with the legacy templates. Default applications now use the pure Go equivalent of kingpin.DefaultUsageTemplate. The existing UsageTemplate and UsageFuncs APIs remain intact to preserve compatibility. Any use of either API will result in text/template rendering usage and preventing deadcode elimination. The basic app used in TestDeadCodeElimination was tested before and after this change. The usage text remained the same, but the binary size shrunk from ~5MB to ~2MB.
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
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.
This was largely inspired by spf13/cobra#1956.
The usage rendering relied on text/template which in turn relied on reflect.MethodByName. As a result, Go's deadcode elimination is prevented from running, and thus means any downstream consumers of kingpin also cannot take advantage of deadcode elimination.
This changes the usage rendering of kingpin such that text/template is not used by default. The existing templates were converted into pure Go functions, and an extensive test suite was added to ensure equality with the legacy templates. Default applications now use the pure Go equivalent of kingpin.DefaultUsageTemplate. The existing UsageTemplate and UsageFuncs APIs remain intact to preserve compatibility. Any use of either API will result in text/template rendering usage and preventing deadcode elimination.
The basic app used in TestDeadCodeElimination was tested before and after this change. The usage text remained the same, but the binary size shrunk from ~5MB to ~2MB.