Changes between Version 45 and Version 46 of TwistedDevelopment


Ignore:
Timestamp:
03/26/2012 10:45:12 PM (3 years ago)
Author:
glyph
Comment:

Add some information about tooling.

Legend:

Unmodified
Added
Removed
Modified
  • TwistedDevelopment

    v45 v46  
    3333  1. At this point, you need to wait for feedback.  If your patch is very good, very simple, and obviously correct, we may just apply it, but it is ''very unlikely'' that the first draft of a patch will be accepted as-is.  When a Twisted developer reviews your patch, they will re-assign the ticket to you; you can [http://twistedmatrix.com/trac/report/7 see the list of tickets assigned to you by clicking here].  Unfortunately, the time it takes us to deal with a ticket submitted for review is highly variable, and depends on how many other tickets are waiting review, the amount of free time that the Twisted core development team has, and how many resources we have available for [http://labs.twistedmatrix.com/ sponsored development]. 
    3434  1. When you do receive a review comment, attach a new patch (again un-assigning the ticket and adding the "review" keyword to it) which addresses that feedback. 
     35 
     36 
     37=== Tools For Development === 
     38 
     39There are a few useful tools for developing Twisted.  Some of them are included with Twisted, some are third-party dependencies. 
     40 
     41To run the tests, simply run `./path/to/Twisted-checkout/bin/trial twisted`. 
     42 
     43To generate the narrative documentation, `cd ./path/to/Twisted-checkout/doc; ../bin/lore --config template=core/howto/template.tpl`. ([ticket:5571 This should be simpler.]) Then open `index.html` (not `index.xhtml`) in your web browser. 
     44 
     45Many ancillary tools related to Twisted are in Bazaar repositories.  You may find it useful to [http://bazaar.canonical.com/en/ install the Bazaar version control system for your platform] so that you can easily get access to these. 
     46 
     47To generate the API documentation, you will need [https://launchpad.net/pydoctor pydoctor].  It depends on [http://epydoc.sourceforge.net/ epydoc], which you can install with `pip install epydoc`.  You can retrieve pydoctor itself with `bzr branch lp:pydoctor`.  Once you've got it, `cd ./path/to/Twisted-checkout/; pydoctor --add-package twisted --make-html` and look in the generated `apidocs` directory. 
    3548 
    3649=== Getting Your Patch Accepted ===