Change: When building NewGRFs, use grfid (from grfcodec) to calculate NewGRF MD5 hash. #11492
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
glx22
reviewed
Nov 25, 2023
glx22
reviewed
Nov 25, 2023
|
Might be simpler to generate md5 file only if cmake has found grfcodec (using grfid that comes with it) and store the md5 file in repo for when grfcodec is not found (like we do for the grf themselves). |
|
What is a bit missing in the motivation, is why you want to do this. I kinda deduce that you want to upgrade from v1 to v2? Maybe for the history add a few words in the description why that is something we would like. Not disgreeing, to be clear, I was just missing the reason why :) Edit: ah, seems #11491 is related to this PR :) Guess that caused it ;) |
|
Now updated to just use grfid from grfcodec only when building the NewGRFs as well. Still a bit of wrangling going on but at least there's no code being duplicated. |
PeterN
changed the title
glx22
reviewed
Nov 26, 2023
glx22
reviewed
Nov 26, 2023
… NewGRF MD5 hash. This allows for v2 container NewGRFs to be created. Hashes are needed for building the baseset metadata, so the .hash files are stored the source tree so they can be built if grfcodec and grfid are not present. The hash of openttd.grf is not actually needed, but it is simpler to leave it in than handle only orig_extra.grf.
glx22
approved these changes
Nov 26, 2023
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.
Motivation / Problem
#11491 adds 32bpp sprites to the extra data NewGRF, which requires it to be built as container v2, but our build scripts do not correctly calculate the MD5 hash for container v2 NewGRFs.
Baseset.cmakeuses CMake's built in MD5 function to calculate the hash oforig_extra.grf. However hash calculation only works for v1 container grfs.The tool
grfidfrom grfcodec can be used to calculate both v1 and v2 hashes, however grfcodec isn't currently a build dependency.Description
Vendor grfid (with some changes due to our updated Md5 implementation and use of fmt, and use it in the build process.Switch to NewGRF container v2. A side effect of this is that the files are a about 10% larger.Update the build system to use grfid from grfcodec to calculate the hash of the custom NewGRFs. This requires a bit more effect than before as MD5 was a nice cmake built-in. The hash is written to a file which is stored in the source tree to enable OpenTTD to be compiled if grfcodec is not present.
Limitations
I removed the copyright message on grfid -- it's my name but I never put that there, so...Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.