[PATCH 0 of 2] document convert-repo interfaces

[Giorgos Keramidas]

On 2007-05-18 22:17, Edouard Gomez <ed.gomez at free.fr> wrote:
>On Wed, 16 May 2007 01:10:35 -0400, Daniel Holth wrote:
>> The first patche creates two new classes, converter_source and
>> converter_sink, that serve to document the main convert-repo
>> interfaces.  The second patch makes everything in convert-repo a new
>> style class, and the conversion classes inherit from the
>> converter_source and converter_sink interfaces.
>
> Hey,
>
> Like you convert-repo interests me, and i've put some hours of work
> also on it. Your patches do clarify the converter classes which i
> missed at the time i hacked into convert-repo.
>
> As i think convert-repo can become a 1st class citizen into the xxx2hg
> converters, i'd like to gather all patches that can make it better:
>  - more user friendly, convert-repo can be a one shot tool for some
>    projects migrating to Mercurial. But for some convert-repo is a good
>    tool at having a hg mirror of a CVS project so cooperating on the
>    project is easy... so the UI could be improved a bit

Another point which is important is that some projects with long-lived
branches, and a clear plan of supporting backwards compatibility for
their existing userbase may need the reverse too, i.e.:

   Once they switch to Hg, a 'gateway' between Hg commits and their old
   CVS tree, which will be maintained for historical reasons.  Users who
   depend on the existing CVS-based infrastructure, can continue to work
   with the tools they find comfortable, but the cutting edge of
   development has moved to Hg and happens there first.

>  - more developer friendly. When someone looks at the convert-repo script
>    he sees something clean, but absolutly nothing that can guide him
>    porting some xxx SCM converter to the convert-repo infrastructure.

The usage is also not so well documented.  I was literally scared away
the first time I looked at convert-repo because of the lack of 'Average
Joe User' documentation.  We don't need something too fancy, mind you.
Just a manpage with usage examples would make things go a long way :)

> Are you interested on such a project ?

I definitely am.