Commits

Benoît Allard  committed 53abfd2

README: word-wrap and fixe some wordings

  • Participants
  • Parent commits 5318c06

Comments (0)

Files changed (1)

 Introduction
 ============
 
-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.
+It all began from a `blog post`_ about bug prediction, that describes
+how some files can be considered as *hot spots* inside a
+codebase. Those files, for instance have to be reviewed more
+carrefully than others, or even, development on them should be done
+with a higher level of alert. 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.
 
 Installation
 ============
 
-Like any other extension, this one has to be enables in one of the mercurial `configuration file`_ like this::
+Like any other extension, this one has to be enables in one of the
+mercurial `configuration file`_ like this::
 
     [extensions]
     hotfiles = path/to/hotfiles.py
 
 .. _`configuration file`: http://www.selenic.com/mercurial/hgrc.5.html
 
+
 Usage
 =====
 
-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 extension adds a new command ``hotfiles`` that displays the ten
+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 command can takes two parameters:
 
--r REV
-    This stop the computation at a particular revision and displays the *hot* files at that time.
+-r REV, --revision=REV
+    This stop the computation at a particular revision and displays
+    the *hot* files at that moment in time. By default, the current
+    parent revision will be used.
 
--p REGEX
-    This is a regular expression used to filter only the commit messages that are related to issues.
+-p REGEX, --pattern=REGEX
+    This is a regular expression used on the commit message to filter
+    only the changesets that are related to issues.
 
 Example::
 
    hg hotfiles -p 'issue\d+'
 
-Will display the ten files the most succeptible to contains bug if run in the Mercurial repository.
+Will display the ten files the most succeptible to contains bug if run
+in the Mercurial repository.
+
+Configuration
+=============
+
+The value of the regex to filter issue changesets can be configured in
+the mercurial configuration file. In this case, if not provided on the
+command line, this one will be taken. The value is configured as
+follow::
+
+    [hotfiles]
+    pattern = issue\d+
+
+If neither the configuration file, nor the command line parameter is
+provided, all non-merge changesets will be considered in the
+computation.
 
 Contributing
 ============
 
-For bug reports, pull requests, comments, ... simply use the Bitbucket interface or send me a mail.
+For bug reports, pull requests, comments, ... simply use the Bitbucket
+interface or send me a mail.