~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/__init__.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
644
644
formats may also be introduced to improve performance and
645
645
scalability.
646
646
 
647
 
Use the following guidelines to select a format (stopping
648
 
as soon as a condition is true):
649
 
 
650
 
* If you are working on an existing project, use whatever
651
 
  format that project is using. (Bazaar will do this for you
652
 
  by default).
653
 
 
654
 
* If you are using bzr-svn to interoperate with a Subversion
655
 
  repository, use 1.14-rich-root.
656
 
 
657
 
* If you are working on a project with big trees (5000+ paths)
658
 
  or deep history (5000+ revisions), use 1.14.
659
 
 
660
 
* Otherwise, use the default format - it is good enough for
661
 
  most projects.
662
 
 
663
 
If some of your developers are unable to use the most recent
664
 
version of Bazaar (due to distro package availability say), be
665
 
sure to adjust the guidelines above accordingly. For example,
666
 
you may need to select 1.9 instead of 1.14 if your project has
667
 
standardized on Bazaar 1.13.1 say.
668
 
 
669
 
Note: Many of the currently supported formats have two variants:
 
647
The newest format, 2a, is highly recommended. If your
 
648
project is not using 2a, then you should suggest to the
 
649
project owner to upgrade.
 
650
 
 
651
 
 
652
Note: Some of the older formats have two variants:
670
653
a plain one and a rich-root one. The latter include an additional
671
654
field about the root of the tree. There is no performance cost
672
655
for using a rich-root format but you cannot easily merge changes
673
656
from a rich-root format into a plain format. As a consequence,
674
657
moving a project to a rich-root format takes some co-ordination
675
658
in that all contributors need to upgrade their repositories
676
 
around the same time. (It is for this reason that we have delayed
677
 
making a rich-root format the default so far, though we will do
678
 
so at some appropriate time in the future.)
 
659
around the same time. 2a and all future formats will be
 
660
implicitly rich-root.
679
661
 
680
662
See ``bzr help current-formats`` for the complete list of
681
663
currently supported formats. See ``bzr help other-formats`` for