Metadata-Version: 1.0
Name: hghooks
Version: 0.2.0
Summary: A set of useful hooks for Mercurial
Home-page: http://bitbucket.org/lgs/hghooks/
Author: Lorenzo Gil Sanchez
Author-email: lorenzo.gil.sanchez@gmail.com
License: LGPL 3
Description: .. contents::
        
        =======
        hghooks
        =======
        
        hghooks is a simple module that adds several useful hooks for use in
        Mercurial hooks system.
        
        Right now it includes hooks for:
        
        * pep8 checking of python files
        * pyflakes checking of python files
        * checking for forgotten pdb statements in python files
        
        
        Documentation
        =============
        
        Installation
        ------------
        
        hghooks is distributed as a Python egg so is quite easy to install. You just
        need to type the following command::
        
        easy_install hghooks
        
        And Easy Install will go to the Cheeseshop and grab the last hghooks for you.
        It will also install it for you at no extra cost :-)
        
        
        Usage
        -----
        
        To use one of the hooks provided by this package edit your hgrc file of
        your Mercurial repository and add these lines::
        
        [hooks]
        pretxncommit.pep8 = python:hghooks.pep8hook
        pretxncommit.pyflakes = python:hghooks.pyflakeshook
        pretxncommit.pdb = python:hghooks.pdbhook
        
        You can add as many hooks as you need. From version 0.2.0 it supports the
        pretxnchangegroup hook too.
        
        How to skip the hooks
        ---------------------
        
        If you need to avoid a hook for a specific changeset you can add one or
        more of the following keywords to the commit message: no-pep8,
        no-pyflakes and no-pdb.
        
        On the other hand, if you want to avoid a hook in a specific file you
        can add a comment somewhere in the file saying so. For example::
        
        # hghooks: no-pyflakes no-pdb
        
        in this case the pyflakes and pdb hooks will skip this file. The
        "``# hghooks:``" prolog is important and you have to type it exactly
        like that. Then add the skip keyworkds separated by spaces.
        
        
        Changes
        =======
        
        0.2.0 (2010-10-14)
        ------------------
        - Support for the pretxnchangegroup hook
        
        0.1.2 (2010-08-31)
        ------------------
        - Fixes issue #2 about erros when removing files
        
        0.1.1 (2010-06-13)
        ------------------
        - Add documentatin about how to skip the checks
        
        0.1.0 (2010-06-13)
        ------------------
        - Initial release
        
Keywords: mercurial pep8 pyflakes
Platform: UNKNOWN
