[tor-bugs] #22762 [Core Tor/Tor]: Revise coding standards expectation for tests to be run before review

Tor Bug Tracker & Wiki blackhole at torproject.org
Thu Jun 29 13:43:48 UTC 2017


#22762: Revise coding standards expectation for tests to be run before review
---------------------------+------------------------------------
 Reporter:  chelseakomlo   |          Owner:  chelseakomlo
     Type:  task           |         Status:  merge_ready
 Priority:  Medium         |      Milestone:  Tor: 0.3.2.x-final
Component:  Core Tor/Tor   |        Version:  Tor: unspecified
 Severity:  Normal         |     Resolution:
 Keywords:  documentation  |  Actual Points:
Parent ID:                 |         Points:
 Reviewer:  catalyst       |        Sponsor:
---------------------------+------------------------------------

Comment (by catalyst):

 I think `make distcheck` is too cumbersome for ordinary contributors to
 run on every patch they submit.  (At the very least, it takes
 significantly longer to run.)  It builds a distribution tarball, does a
 build from that tarball (which easily takes much longer than an
 incremental build), runs `make check`, tests the installation
 rules/scripts, etc.  I think it also won't use any custom `./configure`
 options such as `--enable-fragile-hardening` that might help a developer
 find bugs in new code.  I'm not sure whether `make distcheck` has more
 dependencies than `make check`, but if it does, that might be another
 reason to not require it from all contributors.

 For comparison, the Jenkins builds do only `make check` not `make
 distcheck`.  I think it only makes sense to do `make distcheck` when there
 are changes to build system components.

 I think `make check` is a reasonable tradeoff between thoroughness and
 something that runs quickly enough that contributors would be willing to
 run it.

 Maybe we could additionally recommend running `make distcheck` if you've
 touched build system stuff (like Makefiles or autoconf)?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/22762#comment:6>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list