git pre-commit hook that runs 'make check-spaces' and 'make check-changes'

We already have scripts/maint/pre-push.git-hook which helps preventing fixup commits from ending up in upstream branches. We should also have a pre-commit hook script to prevent creating commits that would fail whitespace and change file checkers.

changed milestone to %Tor: 0.4.0.x-final

added component::core tor/tor milestone::Tor: 0.4.0.x-final owner::rl1987 priority::medium resolution::implemented reviewer::nickm severity::normal status::closed type::enhancement labels

Trac:
Status: new to accepted
Owner: N/A to rl1987

https://github.com/torproject/tor/pull/662

Trac:
Status: accepted to needs_review

Trac:
Reviewer: N/A to nickm

Trac:
Keywords: N/A deleted, 041-proposed added

Looks good, but are a few issues I see:

1. If Tor is configured for out-of-tree builds, or configure hasn't run, then there won't actually be a Makefile in the top level directory.

(Suggested solutions: either we should check whether Makefile exists (risky), or run the several check scripts directly without using the Makefile.)

2. For recent versions, I'd like to run "check-includes" as well. (That script does not exist before 0.3.5, though.)

(The right solution here will depend on what we decide to do for issue 1 above.)

3. For branches based on 0.2.9, "check-changes" won't pass.

(I went and fixed this in dd6c2b0ad77b5bfbf7f06b1d73f8ab85d81154bf.)

4. The changes file should mention where the script is.

(To fix this we can just add the patch to the changes files.)

Moving this ticket into 0.4.0.x, since I think we can safely take this there once it's ready.

Trac:
Keywords: 041-proposed deleted, N/A added
Milestone: Tor: unspecified to Tor: 0.4.0.x-final

Trac:
Status: needs_review to needs_revision

Replying to nickm:

Looks good, but are a few issues I see:

1. If Tor is configured for out-of-tree builds, or configure hasn't run, then there won't actually be a Makefile in the top level directory.

(Suggested solutions: either we should check whether Makefile exists (risky), or run the several check scripts directly without using the Makefile.)

Running scripts directly in aecd176f6e6254ac18e7eadd637695c7df6a8ee9.

2. For recent versions, I'd like to run "check-includes" as well. (That script does not exist before 0.3.5, though.)

(The right solution here will depend on what we decide to do for issue 1 above.)

Running checkIncludes.py in 0a40aa0d2cac30a46debef38e8ff1aa00f52515e.

3. For branches based on 0.2.9, "check-changes" won't pass.

(I went and fixed this in dd6c2b0ad77b5bfbf7f06b1d73f8ab85d81154bf.)

4. The changes file should mention where the script is.

(To fix this we can just add the patch to the changes files.)

Moving this ticket into 0.4.0.x, since I think we can safely take this there once it's ready.

Fixed in 6a1ae1294ad8a2f1412c87db767dd72bbefa7cd4.

Trac:
Status: needs_revision to needs_review

Thanks! I've made two small changes for compatibility with older branches, in a new branch called "precommit_squashed". Please let me know if you like them, and if so, I'll merge this.

Trac:
Status: needs_review to merge_ready

Yes, looks good!

Great; merged to master!

Trac:
Resolution: N/A to implemented
Status: merge_ready to closed

closed

moved to tpo/core/tor#28976 (closed)