Add the ability to generate a text file containing all the licenses that apply to a compiled program. #204
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
This gives QB64-PE the ability to automatically generate a text file comprising all of the licenses that apply to your QB64 program. This file can then be distributed with your program to meet the requirements of those licenses, and also examined to understand what licenses apply to your program. The generation is controlled via a configuration flag, settable either via the `Run` dialog, or via a new `-f` setting on the comamnd line. Fixes: QB64-Phoenix-Edition#145
This adds logic for testing the new license generation functionality. This is done by having the expected license for a variety of tests that use different dependencies, and then comparing that against the license QB64-PE actually produces when compiling these test files. Note that because the actual used dependencies changes depending upon the OS, we have separate expected licenses for each of Linux, Windows, and Mac OS. This required some build changes to accomidate, in addition to the testing logic changes themselves.
This file was checked-in with Windows line endings, but it should have Unix/Linux ones. Windows will automatically convert it into Windows line endings when checking the file out, so it's not a problem in that case.
mkilgore
force-pushed
the
generate-license-file
branch
from
8d15128
to
9e4d77d
Compare
RhoSigma-QB64
approved these changes
Oct 1, 2022
Merged
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.
This change gives QB64-PE the ability to generate a file containing all of the licenses that apply to a compiled program. These licenses come from the QB64-PE runtime itself and also the various libraries we make use of. The file is different depending on what functionality you use and thus what libraries are used by your program.
You can trigger QB64-PE to produce the file either via the IDE or on the command line using the
-f:GenerateLicenseFile=[true/false]switch. The menu option can be seen below:I modified the testing framework to allow testing that the generated license is as expected (which largely just varies that all the dependency licenses can be correctly found, and I examined the produced licenses to verify the make sense). The expected output also gives an example of what the license files look like.
Fixes: #145