fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from it #1500
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1500
Loading…
Reference in a new issue
No description provided.
Delete branch "zeldaootr/Longshot:appimage-fidelityfx-sdk-licence"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type: fix · Risk: low · Tested on: Linux (the AppImage's licence block, run by its test) · Needs: none
TL;DR
Every build compiles AMD's FidelityFX SDK shaders (FSR 3.1 and its frame generation) into the renderer, but the Linux AppImage didn't carry that SDK's MIT licence notice; it carried only the FSR 4 headers' licence. This PR copies the SDK's licence and its provenance note into the AppImage's
licensesfolder, beside the others. A test that fails onmainchecks it. The Windows builder zip already carries it.Breakdown
third_party/fidelityfx(FSR 4's API headers) but notthird_party/fidelityfx-sdk, whose shaders every build compiles in.licenses/fidelityfx-sdk/LICENSE.txtandPROVENANCE.md.third_partyfile).tests/test_appimage_licenses.pyruns the AppImage script's licence block and compares the copied files. It fails onmainand passes here.Why
AMD's FidelityFX SDK (
third_party/fidelityfx-sdk, v1.1.4, MIT) is compiled into every build:scripts/fsr3_shaders.pyturns its FSR 3.1 upscaler, frame-interpolation and optical-flow passes into the SPIR-V headers ingpu/vk/shaders;cp -a gpu/vk);longshot_vk.sois built with them.MIT asks that its notice go with every copy or substantial portion. The AppImage's licence block (
scripts/linux/appimage.sh, "the licences of the third-party parts compiled into longshot_vk.so") copies imgui's, zstd's, the Libertinus fonts' andthird_party/fidelityfx's, which is FSR 4's API headers. The SDK's was missing.The Windows Longshot Builder zip (
scripts/builder_package.py) copies every tracked file underthird_partyintotools\, the SDK'sLICENSE.txtincluded, so it needs no change.How to reproduce
Seen on: main @
310e7c9df, Linux (the AppImage's licence block and its check; no game needed)Steps: read the licence block of
scripts/linux/appimage.sh(the lines between "the licences of the third-party parts" and "end of the licences"), or run this PR's test commit:python -I -B tests/test_appimage_licenses.pyExpected: a
licenses/fidelityfx-sdk/folder with the SDK'sLICENSE.txtandPROVENANCE.md, besideimgui,zstd,libertinusandfidelityfx, sincescripts/fsr3_shaders.pycompiles the SDK's FSR 3.1 passes intogpu/vk/shaders' headers that every build hasActual: no such folder; the check fails with
No such file or directory: .../licenses/fidelityfx-sdk/LICENSE.txtWhat changed
The AppImage now ships AMD's FidelityFX SDK licence beside the other third-party licences.
scripts/linux/appimage.sh: the licence block makeslicenses/fidelityfx-sdk/and copiesthird_party/fidelityfx-sdk/LICENSE.txtandPROVENANCE.mdinto it.tests/test_appimage_licenses.py:WANTnames the two files;test_vk_third_party_coveredalso requires them wheneverscripts/fsr3_shaders.pycompiles fromthird_party/fidelityfx-sdkand the image carriesgpu/vk.Measurements
Nothing to measure: packaging only; the check above is the measurement.
Flags and settings
None.
Testing
Tested:
python -I -B tests/test_appimage_licenses.pyon Linux: onmainit errors withNo such file or directory: .../licenses/fidelityfx-sdk/LICENSE.txt; hereOK(4 tests).python -I -B tests/run_all.py --changed main: 14 passed, 0 failed.shellcheck -S warning scripts/linux/appimage.sh: clean.Not tested: a full AppImage build; the licence block is the part that changed, and its test runs it.
Must be tested: none.
Risks
What could break: nothing at run time; the AppImage build would stop if the SDK's files were moved, which the test would catch first.
Turning it off: revert the commit.
Compatibility: nothing changes for a player.
Checklist
Everyone
type(scope): description) of the status line's type.main.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named). (The changed set: 14 checks, all passing.)third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.mainand passing here.tests/that reads changed source updated in this PR, not weakened.Description completed: How to reproduce added, and the box for the check that reads the changed script.
WIP: fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from itto fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from it