Group Extension
This extension is not distributed with Mercurial.
Author: Arne Babenhauserheide
Download site: http://freehg.org/u/ArneBab/hgext_group/
Overview
Add a comment as summary to a group of changesets, so they get shown together in the log as one contribution.
This way we can do nice looking contributions with comprehensive and concise description without having to destroy the path we took to reach them.
And for the smaller scale, I as developer can say "These are some of my commits. All together they fix bug 12345" and do the same for other related commits.
Others who do a hg log then first see my message for the whole group as if it was one signel commit (with some info, that it's a group) and can inspect the contents of the group seperately, if they want to.
It allows people to trace others work, while not cluttering the default log with information which is mostly useful while debugging or researching project history.
.hggroups should look like this:
"description_line" rev1_hex rev2_hex ...
"description_line" rev1_hex rev2_hex ...
"description_line" rev1_hex rev2_hex ...
Definition for the commit message:
Group Added: FIRST LINE OF GROUP DESCRIPTION REST OF DESCRIPTION, arbitrary length and style.
Date and user are already in the ctx.
Sorted by the group number.
(basic question: should there be a version header in the .hggroups file, so its layout can be updated at a later time?)
The log should look like:
changeset: 5:1a8a0fe7ab0a
user: Arne Babenhauserheide <bab@draketo.de>
date: Fri Jun 27 09:48:08 2008 +0200
summary: First call log when group gets started to get useful output while developing.
changeset: 4:880f870098c8
user: Arne Babenhauserheide <bab@draketo.de>
date: Fri Jun 27 09:29:45 2008 +0200
summary: Added tag v0.0 for changeset 333aaf680223
group: 0:some_short_hex
tags: v0.0 v0.1 v0.2 ...
changesets: 1 3
user: Arne Babenhauserheide <bab@draketo.de>
date: Fri Jun 27 09:29:45 2008 +0200
summary: Grouped changes summary. Displayed above the most recent grouped changeset.
changeset: 3:880f870098c8 in group 0
changeset: 2:9db08cf8e902
user: Arne Babenhauserheide <bab@draketo.de>
date: Thu Jun 26 18:22:24 2008 +0200
summary: First step: Printing the REVs we want to add as group - only commandline parsing, no real action, yet.
Basic Steps:
- First test: Call a modified log which shows the group passed via the commandline. - done
- Then save a passed group in a .hggroups file and add and commit the file. - done
- Then hide the grouped changesets in the modified log. - done
- Before adding a group, update to the most recent revision of the group (and then merge), so the group is a child of the most recent revision and updating to the group always gives the code of the group (groups can be added far later than the actual code is written and finished). - done
- Provide a commandline switch and a config setting to activate / deactivate the grouped log, default: off. (wish from parren) - done
- Get back the full log feature set. - done, I hope
- Provide a groupinspect command which shows the revisions inside the group just like hg log. - done
Advanced Steps:
- Provide a template for log to show groups differently.
- Hide group merges in the grouped log.
- Make the basic Mercurial commands recognize groups.
- Show grouped changesets as stubs as shown in the log example. - switchable via the commandline. ("show-grouped-node-stubs" or similar)
- Adapt the parents and children in the output (must be calculated at runtime, since it can change later on. Also this keeps the .hggroups file relatively small).
- Modify hg view to show the groups, maybe provide a patch to the general log command.
Initiating email to the Mercurial mailinglist:
http://selenic.com/pipermail/mercurial/2008-June/019832.html
Wishes:
Export groups as a patch. -> overwrite export.
Email groups. -> overwrite email.
Make it possible to pass revs as multiple ranges ( 1:3 -> 1 2 3 , 1:4 5:7 -> 1 2 3 4 5 6 7, 1:3 2:6 -> 1 2 3 4 5 6 )
- Show grouped output in hg view.
Bugs:
Implemented wishes:
- Add -m option (a-la commit) for group would be nice: hg group -m "My group" 2 4 7 - done by Sean Russel
- Make hg view work with activated group extension. - done -
Configuration
Configure your .hgrc to enable the extension by adding following lines:
[extensions] group = /path/to/group.py [groups] grouped_log = True