+:author: Benoît Allard <email@example.com>
+It all began from a `blog post`_ about bug prediction, that describes how some files can be considered as *hot spots* inside a codebase. Thos files, for instance have to be reviewed more carrefully than others, or even, development on them should be done with a higher alert level. The trouble is only, how to detect those files when you are new to the codebase. The Google blog post quotes a_ few_ papers_ that shows that history can helps.
+I decided to implement their method as a Mercurial_ extension.
+.. _`blog post`: http://google-engtools.blogspot.com/2011/12/bug-prediction-at-google.html
+.. _a: http://research.microsoft.com/apps/pubs/default.aspx?id=69126
+.. _few: http://scholar.google.com/scholar?q=Bug+Cache+for+inspections%3A+hit+or+miss%3F
+.. _papers: http://scholar.google.com/scholar?cluster=338532016657424558
+.. _Mercurial: http://mercurial.selenic.com
+Like any other extension, this one has to be enables in one of the mercurial `configuration file`_ like this::
+ hotfiles = path/to/hotfiles.py
+.. _`configuration file`: http://www.selenic.com/mercurial/hgrc.5.html
+This extension adds a new command ``hotfiles`` that displays the 10 files the most succeptible to have issues. Or at least, the one that contained issues in the late time.
+This command takes two parameters:
+ This stop the computation at a particular revision and displays the *hot* files at that time.
+ This is a regular expression used to filter only the commit messages that are related to issues.
+ hg hotfiles -p 'issue\d+'
+Will display the ten files the most succeptible to contains bug if run in the Mercurial repository.
+For bug reports, pull requests, comments, ... simply use the Bitbucket interface or send me a mail.