riscv-software-src / riscv-pk

RISC-V Proxy Kernel
Other
595 stars 308 forks source link

Untrack auto-generated files #263

Closed ZenithalHourlyRate closed 2 years ago

ZenithalHourlyRate commented 2 years ago

./configure and other config files are machine dependent hence should not be tracked by git.

As for aclocal.m4, it was not generated by aclocal, instead it was copied from mcppbs repo thus should be put to m4/

Unfortunately, we do not have Makefile.am thus we can not untrack Makefile.in now

Reference: https://github.com/github/gitignore/blob/main/Autotools.gitignore

sequencer commented 2 years ago

all distros supports the autotools by default, maybe this only needs some modification to the build script? Another possibility is porting repositories to modern build systems(like CMake, Meson).

aswaterman commented 2 years ago

This isn't a problem that needs fixing. I acknowledge it's annoying for some, but it really is just that. Switching to a new build system will certainly break things for other people. Breaking the build is far worse than causing minor annoyance.

sequencer commented 2 years ago

I see...

eli-schwartz commented 2 years ago

Our convention in these repos is to commit these files to unburden users from needing the right versions of all of these extra tools.

This clutters up git history with huge auto-generated files, requires maintenance commits that exist merely to upgrade the versions of generated files, and serves no purpose that isn't also served by releasing make dist tarballs.

aswaterman commented 2 years ago

Yes, we are aware of the downsides of this approach. Please bear in mind that we are balancing multiple competing concerns here, and that we aren’t alone in making this decision. Consider another much more prominent pair of projects that does the same thing: https://github.com/bminor/binutils-gdb/blob/master/configure https://github.com/gcc-mirror/gcc/blob/master/configure