Opened 3 months ago

Closed 4 weeks ago

#32455 closed task (implemented)

Run "make doxygen" in a travis builder

Reported by: nickm Owned by: rl1987
Priority: Medium Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: doxygen tor-ci 043-should
Cc: Actual Points:
Parent ID: Points: .3
Reviewer: nickm Sponsor: Sponsor31-can

Description

With #32385, we now have --enable-fatal-warnings behave sensibly with doxygen warnings. We can prevent ourselves from introducing new doxygen warnings by having a travis builder that does "make doxygen".

This won't apply to warnings about missing documentation: those are off by default, since we have a few thousand of them.

Child Tickets

Change History (10)

comment:1 Changed 3 months ago by nickm

Parent ID: #29214

comment:2 Changed 3 months ago by nickm

Parent ID: #29214

comment:3 Changed 7 weeks ago by nickm

Keywords: 043-should added

comment:5 Changed 5 weeks ago by nickm

Reviewer: nickm
Status: needs_reviewneeds_revision

I wonder if we can add this to an existing builder, instead of making a new builder? Using a separate builder here makes us recompile Tor unnecessarily, which I would expect would slow down CI.

comment:6 Changed 4 weeks ago by nickm

Owner: set to rl1987
Status: needs_revisionassigned

Setting owner.

Rl1987, please let us know if you won't be revising this in the next month or so? I'd like to get it into 0.4.3 if possible.

comment:7 Changed 4 weeks ago by nickm

Status: assignedneeds_revision

comment:8 in reply to:  5 Changed 4 weeks ago by teor

Replying to nickm:

I wonder if we can add this to an existing builder, instead of making a new builder? Using a separate builder here makes us recompile Tor unnecessarily, which I would expect would slow down CI.

I suggest the coverage build, in case we ever want to do documentation coverage.

We could also add a new builder, but run "make doxygen" instead of "make" or "make src/app/tor". Linux builders only cost us a few 10s of seconds to start up and clone tor.

comment:9 Changed 4 weeks ago by rl1987

But it does not recompile Tor binary (SKIP_MAKE_CHECK is set to true)? Above example build took 1 min. 33 seconds to complete.

I can move make doxygen command to the end of coverage build though. This would be slightly faster, as we wouldn't need to rerun configure.

comment:10 Changed 4 weeks ago by nickm

Resolution: implemented
Status: needs_revisionclosed

Oh, you're right! I had thought incorrectly that there was a make all invocation that SKIP_MAKE_CHECK didn't skip. I think this patch is fine, then. Merged, and thanks for your patience!

Note: See TracTickets for help on using tickets.