[MERGE] improved help on storage formats

Stephen J. Turnbull stephen at xemacs.org
Fri Dec 12 00:55:56 GMT 2008


A few gnits:

Matthew D. Fuller writes:

 > I envision `help formats` looking more like:

Looks nice, really.

 > --------------------------------
 > Current Storage Formats
 > 
 > pack-0.92:
 >     (native) (default) New in 0.92: Pack-based format with data
 >     compatible with dirstate-tags format repositories. Interoperates
 >     with bzr repositories before 0.92 but cannot be read by bzr <
 >     0.92. Previously called knitpack-experimental.  For more
 >     information, see http://doc.bazaar-
 >     vcs.org/latest/developers/packrepo.html.

Nuke the previous name if it's -experimental.  Then the last three
lines could come out

    0.92.  For more information, see
    http://doc.bazaar-vcs.org/latest/developers/packrepo.html.

 > 1.6:
 >     (native) A branch and pack based repository that supports
 >     stacking.

Urgh.  As you say, means what?

 > See ``bzr help deprecated-formats`` for older formats.
 > See ``bzr help experimental-formats`` for experimental formats.

Prefix 

    See ``bzr help semantics-of-formats`` for explanation of
    capabilities of formats.

maybe?

 > (It sure is annoying how URL's get split across lines...

That's no annoyance, that's a *bug*.<wink>

 >    Similarly, the ordering in deprecated could use rework too.  It
 >    seems to me they should be in age order (whether newest-first or
 >    oldest-first, there are points either way)

Newest-first.  Experimental should be either in order of expected
landing or (as an approximation to that) oldest-first.

 > 2) It's kinda annoying for the rich-root variants to repeat the whole
 >    description of their counterpart just to add "and rich root data"
 >    to the end.  Just point at it.

I think a "bzr help semantics-of-formats" or "features-of-formats"
page would address this point better.



More information about the bazaar mailing list