How to describe your patch (was Re: [PATCH 0 of 1] preliminary support of subrepositories)

Matt Mackall mpm at selenic.com
Wed Feb 4 15:45:59 CST 2009


On Wed, 2009-02-04 at 21:45 +0200, Alexander Solovyov wrote:
> Hi,
> 
> this is patch, which adds support of subrepositories.
> 
> I thought I could split it in smaller patches but only things I could invent to
> extract are commands.sublist and string prepending support in ui. I still can
> do that if you like.
> 
> I'd like to hear your opinions on code: what's good and what's not, because
> I'm not sure about some parts, particularly in dirstate.
> 
> But anyway it works. ;-)
> 
> How to use it?
> 
> Edit file .hgsubrepos (located in the repo root) to contain inner path to subrepo
> and path to it's source, like:
> 
> apps/pingback http://hg.piranha.org.ua/django-pingback/
> 
> Spaces in the name or in the path are not supported: this should be solved 
> (any suggestions how?).
> 
> Then just run "hg add .hgsubrepos" and "hg update". Is that good enough? I'm not sure what to do if you'd like to add subrepo in old revision - this will bring you to the tip...
> 
> I hope I haven't forgot anything I planned to say. If I had, I'll follow with a new mail. ;-)

I'm afraid you've left out absolutely everything that _I_ want to see in
a major feature description. 

I need to know:

- why we need this feature (in this case, I already know)
- how you've implemented it
- what file formats and data structures you've used
- what choices you've made
- why the choices you've made are the right ones
- why the choices you didn't make are the wrong ones
- what shortcomings exist
- what compatibility issues exist
- what's missing, if anything

In this case, I have some broad outlines, as we've discussed it, but
that doesn't go a very far to understanding your code.

-- 
http://selenic.com : development and support for Mercurial and Linux




More information about the Mercurial-devel mailing list