On Feb 20, 2014, at 6:00 AM, Adi Roiban <a...@roiban.ro> wrote:

> While submitting a patch on Twisted I got a review response that my code is 
> not complaint with `twistedchecker`.
> 
> My first reaction was: Holy code, what is twistedchecker!

As new tools are added to our development process to make things easier (the 
things twistedchecker checks for used to be entirely manual) it's an ongoing 
struggle to keep our documentation up to date.

> Now that I got some info about twistedchecker  and wiki write access I would 
> like to update the https://twistedmatrix.com/trac/wiki/TwistedDevelopment 
> wiki page with information about how a Twisted developer is expected to use 
> twistedchecker.

Please do!

> I run twistedcheck on trunk and got a lot of errors.

Yes.

Because the things twistedchecker checks for used to be manual, we used to fail 
to check for a lot of them.  And many of the things it checks for were not even 
thought of when Twisted was first developed.  This means that the codebase is 
largely not compliant with twistedchecker.

> Am I suppose to look through all those error and filter the ones generated by 
> my changes?

Yes and no.

Yes, in that you should only care about the new ones that your changes created. 
 We aim to have the number of twistedchecker warnings decreasing over time; but 
as long as trunk still produces hundreds and hundreds of warnings we're never 
going to have a big project to eliminate them in one fell swoop.

No, in that you don't have to do this yourself, the buildbot will do it for 
you.  For example, if on the page for this build 
<http://buildbot.twistedmatrix.com/builders/twistedchecker/builds/1815> you 
click on "new twistedchecker errors", you will see 
<http://buildbot.twistedmatrix.com/builders/twistedchecker/builds/1815/steps/run-twistedchecker/logs/new%20twistedchecker%20errors>
 a very small number of warnings.  If there are no new twistedchecker errors, 
the builds should succeed.  (This mechanism isn't perfect, however; sometimes 
it fails, although less now than it used to.)

> Since twistedchecker is only about twisted, shouldn't it be included as a 
> dependency to twisted-dev-tools so that as I developer I would only need to 
> install one extra package and it will pull all development/testing 
> depenencies?

Sounds like a good idea to me.

> Thanks!

Thank you for pointing this out!

-glyph


Attachment: smime.p7s
Description: S/MIME cryptographic signature

_______________________________________________
Twisted-Python mailing list
Twisted-Python@twistedmatrix.com
http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python

Reply via email to