NetPlayIndex: Use scm_rev_str instead of scm_desc_str for version check #9898
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
Some build systems (i.e. Nix) make it architecturally impossible to acquire the correct scm_desc_str that we normally use for builds, making it basically impossible for users of those to use the NetPlay browser, unless they manually override the version string. Not relying on this string in the first place for any actual functionality beyond display to the user would be beneficial, and using the scm_rev_str instead matches the check on actually joining a session anyways, so it makes sense to do it this way.
MatthewCroughan
added a commit
to MatthewCroughan/nixcfg
that referenced
this pull request
Jul 17, 2021
…e netplay usable in my configuration It is not possible to use git describe in a pure system like Nix which hashes all inputs, (since the git index changes whenever anybody pushes a branch, etc), so I have set DOLPHIN_WC_DESCRIBE to the first 8 chars of the scm revision instead of the usual expected value since I have no way of retrieving it. Until dolphin-emu/dolphin#9898 is merged I will be unable to use the Netplay browser, but the scm revision is enough to join Netplay sessions.
|
Pinging @spycrab to review this since he manages the NetPlay lobby backend. |
|
Marking this as draft until the backend is updated. |
|
Does this PR and the backend PR need to be merged simultaneously? |
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.
Some build systems (i.e. Nix) make it architecturally impossible to acquire the correct scm_desc_str that we normally use for builds, making it basically impossible for users of those to use the NetPlay browser, unless they manually override the version string. Not relying on this string in the first place for any actual functionality beyond display to the user would be beneficial, and using the scm_rev_str instead matches the check on actually joining a session anyways, so it makes sense to do it this way.
This requires a backend change to the NetPlay lobby server, found at dolphin-emu/netplay-index#6
A bit of background: the reason why it is impossible to acquire the
git describeoutput that we use for the scm_desc_str, in the case of Nix, is because Nix is a reproducible build system, and Git by design has a constantly changing index which can't be fetched and hashed in a reproducible way, so it is stripped out at build time (or simply not fetched in the first place) to avoid that problem.