[tor-bugs] #31713 [Core Tor/Tor]: Automatically run the autostyle scripts before every commit (was: Automatically run "make autostyle" before every commit)

Tor Bug Tracker & Wiki blackhole at torproject.org
Fri Sep 27 22:26:41 UTC 2019


#31713: Automatically run the autostyle scripts before every commit
--------------------------+----------------------------------
 Reporter:  teor          |          Owner:  (none)
     Type:  enhancement   |         Status:  new
 Priority:  Medium        |      Milestone:  Tor: unspecified
Component:  Core Tor/Tor  |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:                |  Actual Points:
Parent ID:  #29226        |         Points:
 Reviewer:                |        Sponsor:  Sponsor31-can
--------------------------+----------------------------------

Old description:

> Let's try out our auto-formatting workflow by running:
> scripts/maint/rectify_include_paths.py .
> before every commit.
>
> We occasionally miss include paths:
> https://github.com/torproject/tor/pull/1319/commits/a90d1918af5d2b6c6e6dd2c0797f8a63d4042bfa
>
> We should only ever run auto-formatting on master.

New description:

 Let's try out our auto-formatting workflow by running:
 scripts/maint/rectify_include_paths.py .
 before every commit.

 We occasionally miss include paths:
 https://github.com/torproject/tor/pull/1319/commits/a90d1918af5d2b6c6e6dd2c0797f8a63d4042bfa

 We should only ever run auto-formatting on master.

 Edited to add:

 We'll need to use a similar strategy to practracker, where we check for
 the presence of a file before running the autostyle scripts.

 We can't use "make autostyle" directly, because some commit directories
 haven't run configure, so they don't have a Makefile. Instead, we should
 do what we do with all the other hook scripts, and copy the code from
 "make autostyle" to the hook. (Or even better, create a style script, and
 call it from "make autostyle" and the hook.)

--

Comment (by teor):

 We'll need to use a similar strategy to practracker, where we check for
 the presence of a file before running the autostyle scripts.

 We can't use "make autostyle" directly, because some commit directories
 haven't run configure, so they don't have a Makefile. Instead, we should
 do what we do with all the other hook scripts, and copy the code from
 "make autostyle" to the hook. (Or even better, create a style script, and
 call it from "make autostyle" and the hook.)

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


More information about the tor-bugs mailing list