Remove generated files from the repository #642
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
rvaiya
reviewed
Feb 10, 2024
Makefile
Outdated
| @@ -88,14 +88,14 @@ uninstall: | |||
| $(DESTDIR)$(PREFIX)/bin/keyd-usb-gadget.sh \ | |||
| $(DESTDIR)$(PREFIX)/lib/systemd/system/keyd.service | |||
| clean: | |||
| -rm -rf bin keyd.service | |||
| rm -rf bin data/*.1.gz data/keyd.compose keyd.service | |||
There was a problem hiding this comment.
compose and run are not included the default/clean targets so the user doesn't need to have python or scdoc on their system. The generated assets are deliberately checked into the repo.
There was a problem hiding this comment.
Pros to removing generated files:
- It simplifies the work of downstream packagers that have to tweak the input files or the build process.
- It eliminates any chance that the checked-in generated files become out of sync with the checked-in input files.
- The codebase is easier for potential contributors to understand.
- No need to review changes to generated files when a pull request modifies the input files.
Cons to removing generated files:
- Users building keyd will have to install python and scdoc. (Users running a pre-built binary package are unaffected.) Such users already have to know how to install a C compiler and dependency headers; adding python and scdoc to the list does not seem overly burdensome to me.
- Building takes much more time now. (It's still sufficiently fast enough, in my opinion. Also, incremental build speed can be restored with some further tweaks to the
Makefile.)
(Please let me know if anything was omitted.)
rhansen
force-pushed
the
build
branch
3 times, most recently
from
a7cc2e1
to
88ebfc5
Compare
rhansen
changed the title
The `-f` option causes `rm` to silently ignore files that don't exist, so `rm -rf` will only fail if `rm` has trouble deleting a file that exists. We want `make` to fail in that situation.
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.
I am currently working on creating a Debian package for keyd, and would like to upstream some build system cleanup commits:
mkdir -pinstead of ignoring return codemake allto make everything