[PATCH 1 of 1] churn: improve description

[Cedric Duval]

timeless wrote:
> > "histogram of changes to the repository"?

> that actually means something. if it's remotely acceptable, please run
> with it :)

While we are at it, a look at the whole extensions list might be in order.
We should certainly try to be more consistent with the use of substantive
or verb forms, currently we have a "happy" mix of styles.

I am trying to address this below, and will make the relevant changes
once we reach a good shape.

Additions, suggestions and improvements most welcome. :)
(but do keep in mind the width constraints).


 acl             (no help text available)

     "allow or deny access to parts of a repository"?

     This one does not have documentation at all, other than in source
     comments. Those should be upgraded to python doc.

 bookmarks       Mercurial bookmarks

     "track a line of development with moving pointers"?

 bugzilla        Bugzilla integration

     "integrate Mercurial with the Bugzilla bug tracker"?

 children        (no help text available)

     "show the children of a revision"?

 churn           command to show certain statistics about revision history

     "display statistics about the repository history"?

 color           add color output to status, qseries, and diff-related commands

     Ok, if a bit long-ish.

 convert         converting foreign VCS repositories to Mercurial

     s/converting/convert/ ?

 extdiff         

     "use an external diff tool"?

 fetch           pulling, updating and merging in one command

     "pull, update and merge in one command"?

 gpg             (no help text available)

     "sign and verify changesets"?

 graphlog        show revision graphs in terminal windows

     Ok

 hgcia           CIA notification

     "integrate Mercurial with the CIA notification service"?

 hgk             browsing the repository in a graphical way

     s/browsing/browse/ ?

 highlight       syntax highlighting in hgweb, based on Pygments

     Simply "hilight syntax in hgweb"? Leaving information about
     dependencies to the longer description.

 inotify         inotify-based status acceleration for Linux systems

     Probably ok, though perhaps we could leave out "inotify-based",
     as it is obvious from the name of the extension, and the long
     description is a better place to delve with technical details.

 interhg         (no help text available)

     No documentation either for this one, comments need to be
     upgraded into python doc.

     "use the InterWiki syntax in changelog and summaries"?

 keyword         keyword expansion in local repositories

     "expand keywords in the working directory"?

     From the extension's description ("Keywords are only expanded in
     local repositories and not stored in the change history."), the
     above might be more accurate.

 mq              patch management and development

     "work with a stack of patches"?

     "... on top of the working directory"?

 notify          hook extension to email notifications on commits/pushes

     "email notifications upon commits/pushes"?

 pager           browse command output with external pager

     Ok

 parentrevspec   use suffixes to refer to ancestor revisions

     Ok

 patchbomb       sending Mercurial changesets as a series of patch emails

     s/sending/send/ ?

 purge           (no help text available)

     "clean working directory from files not tracked by Mercurial"?

 rebase          move sets of revisions to a different ancestor

     Ok

 record          interactive change selection during commit or qrefresh

     "interactively select which sets of changes to commit/qrefresh"?

 share           (no help text available)

     "share a common history between several working directories"?

 transplant      patch transplanting tool

     Just like the header to the longer description,
     "transplant changesets from another branch"?

 win32mbcs       allow to use MBCS path with problematic encoding.

     Remove ending dot

 win32text       (no help text available)

     Again, need to upgrade (and improve) source comments as python
     doc.

     "preform automatic newline conversion"?

 zeroconf        zeroconf support for Mercurial repositories

     "discover and advertise repositories on the local network"?

-- 
Cédric