licensecheck: add Trace function #35
Open
Conversation
This file contains 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
Add the Trace function, which sets the match.TraceDFA variable. This is invaluable for debugging uses of this package. As one example, you are faced with what seems to be a fine Apache-2.0 license that nonetheless isn't matched by any LRE. You try to compare the text to the LRE, but quickly realize that this task is toilsome and inaccurate. Calling Trace and running again immediately reveals that someone has s/product/bundle/, resulting in "reproduction" being altered to "rebundleion". (True story.) Trace is also useful when writing custom LREs to capture new license variants.
|
FWIW the expectation was that you'd do this by adding a test case to package licensecheck and then using Does that work in your context? |
|
It does, and I was doing that. But it seems wrong to have to modify licensecheck when I'm debugging my own custom LREs, not ones I plan to add to the licensecheck corpus. |
Toronto00
approved these changes
Feb 5, 2021
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.
Add the Trace function, which sets the match.TraceDFA variable.
This is invaluable for debugging uses of this package.
As one example, you are faced with what seems to be a fine Apache-2.0
license that nonetheless isn't matched by any LRE. You try to compare
the text to the LRE, but quickly realize that this task is toilsome
and inaccurate. Calling Trace and running again immediately reveals
that someone has s/product/bundle/, resulting in "reproduction" being
altered to "rebundleion". (True story.)
Trace is also useful when writing custom LREs to capture new license
variants.