[RFC] metaweave format

[John Arbash Meinel]

Olaf Conradi wrote:
> On 28/04/06, John Arbash Meinel <john at arbash-meinel.com> wrote:

...

>> I would rather have the default be "default". Because in the future we
>> may come up with something better than "metadir".
> 
> OK, I agree that's better.
> 
>> Since no client has been officially released with --format=metadir, I
>> would be okay with just changing its name to --format=metaweave, and
>> fixing the bug that caused it to create knit format.
> 
> Patch attached.
> 
> This changes "metadir" to "metaweave" which is metadirformat1 with
> format7 weave repo.
> Introduced format "default" which points to metadirformat1 (and is knit)
> Fixes test cases accordingly.
> Mentions "knit" as only supported format in "bzr help init" and "bzr
> help init-repo". All other formats are available, but not shown in the
> help. They are shown in "bzr help upgrade".
> 
> So when a users knows what he is doing, he can use a deprecated format.
> 
> http://deschacht.student.utwente.nl/bzr/bazaar-vcs/bzr.olaf.metaweave/
> 
> -Olaf
> 

...

>  
> @@ -902,12 +906,14 @@
>      takes_options = [
>                       Option('format', 
>                              help='Create a specific format rather than the'
> -                                 ' current default format. Currently this '
> -                                 ' option only accepts "metadir"',
> +                                 ' current default format. Currently, the'
> +                                 ' only supported format is "knit"',
>                              type=get_format_type),
>                       ]

If we are only going to mention one format, I would tend to say it as:
"The recommended format is 'knit'".
I think we are honestly planning to support all of the formats, so
saying 'knit' is the only supported one is wrong.

Maybe this:
Specify the format for this branch. Current options are: default, knit,
metaweave, and weave. default=knit, metaweave and weave are deprecated.

It is a little bit long, but I think it is honest.

Because it is long, and probably more confusing/distracting, I would
tend to move the help text into some sort of advanced section. And do
something like:
Specify the format for this branch. See "bzr help branch-formats" for
more information.

At present, we don't have a good mechanism for detailed extra help (at
least that I know of). But I think that would be useful to have.
It would also help us for "bzr help revision-specs", which we have long
had issues with.

Attached is kind of a prototype of that system. There could certainly be
other ways of doing it. What do people think?

John
=:->
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: extra-help.patch
Url: https://lists.ubuntu.com/archives/bazaar/attachments/20060429/95e3b870/attachment.diff 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 254 bytes
Desc: OpenPGP digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20060429/95e3b870/attachment.pgp