4
.. These documents are formatted as ReStructuredText. You can ..
5
.. convert them to HTML, PDF, etc using the ``python-docutils`` ..
9
*Bazaar-NG* (``bzr``) is a project of `Canonical Ltd`__ to develop an
10
open source distributed version control system that is powerful,
11
friendly, and scalable. The project is at an early stage of
14
__ http://canonical.com/
17
**Note: These documents describe the initial design and are out of
18
date in parts.** For more up-to-date information see the wiki at
19
http://bazaar.canonical.com/
21
For more information, see the homepage at http://bazaar-ng.org/
28
* `Project overview/introduction <intro.html>`__
30
* `Command reference <cmdref.html>`__ -- intended to be user
31
documentation, and gives the best overview at the moment of what the
32
system will feel like to use. Fairly complete.
35
Requirements and general design
36
-------------------------------
38
* `Various purposes of a VCS <purpose.html>`__ -- taking snapshots and
39
helping with merges is not the whole story.
41
* `Requirements <requirements.html>`__
43
* `Costs <costs.html>`__ of various factors: time, disk, network, etc.
45
* `Deadly sins <deadly-sins.html>`__ that gcc maintainers suggest we avoid.
47
* `Overview of the whole design <design.html>`__ and miscellaneous
50
* `File formats <formats.html>`__
52
* `Random observations <random.html>`__ that don't fit anywhere else yet.
56
Design of particular features
57
-----------------------------
59
* `Automatic generation of ChangeLogs <changelogs.html>`__
61
* `Cherry picking <cherry-picking.html>`__ -- merge just selected non-contiguous changes from a branch.
63
* `Common changeset format <common-format.html>`__ for interchange
66
* `Compression <compression.html>`__ of file text for more efficient storage.
68
* `Config specs <config-specs.html>`__ assemble a tree from several places.
70
* `Conflicts <conflicts.html>`_ that can occur during merge-like
73
* `Ignored files <ignore.html>`__
75
* `Recovering from interrupted operations <interrupted.html>`__
77
* `Inventory command <inventory.html>`__
79
* `Branch joins <join-branches.html>`__ represent that all the changes
80
from one branch are integrated into another.
82
* `Kill a version <kill-version.html>`__ to fix a broken commit or
84
remove confidential information from the history.
86
* `Hash collisions <hashes.html>`__ and weaknesses, and the security
89
* `Layers <layers.html>`__ within the design
91
* `Library interface <library-interface.html>`__ for Python.
93
* `Merge <merge.html>`__
95
* `Mirroring <mirroring.html>`__
97
* `Optional edit command <optional-edit.html>`__: sometimes people
98
want to make the working copy read-only, or not present at all.
100
* `Partial commits <partial-commit.html>`__
102
* `Patch pools <pool.html>`__ to efficiently store related branches.
104
* `Revfiles <revfile.html>`__ store the text history of files.
106
* `Revfiles storing annotations <revfile-annotation.html>`__
108
* `Revision syntax <revision-syntax.html>`__ -- ``hello.c@12``, etc.
110
* `Roll-up commits <rollup.html>`__ -- a single revision incorporates
111
the changes from several others.
113
* `Scalability <scalability.html>`__
115
* `Security <security.html>`__
117
* `Shared branches <shared-branches.html>`__ maintained by more than
120
* `Supportability <supportability.html>`__ -- how to handle any bugs
121
or problems in the field.
123
* `Place tags on revisions for easy reference <tagging.html>`__
125
* `Detecting unchanged files <unchanged.html>`__
127
* `Merging previously-unrelated branches <unrelated-merge.html>`__
129
* `Usability principles <usability.html>`__ (very small at the moment)
131
* `<use-cases.html>`__
133
* `<web-interface.html>`__
135
* `<workflow.html>`__ Modelling/controlling flow of patches.
137
* `<yaml.html>`__ -- Discussion of using YAML_ as a storage or transmission format.
139
.. _YAML: http://www.yaml.org/
143
Comparisons to other systems
144
----------------------------
146
* `Taxonomy <taxonomy.html>`__: basic questions a VCS must answer.
148
* `Bitkeeper <bitkeeper.html>`__, the proprietary system used by some
151
* `Aegis <compared-aegis.html>`__, a tool focussed on enforcing
152
process and workflow.
154
* `Codeville <compared-codeville.html>`__ has an intruiging but
155
scarcely-documented merge algorithm.
157
* `CVSNT <compared-cvsnt.html>`__, with more Windows support and some
160
* `OpenCM <compared-opencm.html>`__, another hash-based tool with a
163
* `PRCS <compared-prcs.html>`__, a non-distributed inventory-based tool.
165
* `GNU Arch <todo-from-arch.html>`__, with many pros and cons.
167
* `Darcs <darcs.html>`__, a merge-focussed tool with good usability.
169
* `Quilt <quilt.html>`__ -- Andrew Morton's patch scripts, popular with kernel maintainers.
171
* `Monotone <monotone.html>`__, Graydon Hoare's hash-based distributed system.
173
* `SVK <svk.html>`__ -- distributed operation stacked on Subversion.
175
* `Sun Teamware <compared-teamware.html>`__
178
Project management and organization
179
-----------------------------------
181
* `Notes on how to get a VCS adopted <adoption.html>`__
183
* `Thanks <thanks.html>`__ to various people
185
* `Extra commands <extra-commands.html>`__ for
186
internal/developer/debugger use.
188
* `Choice of Python as a development language <python.html>`__
added
removed
doc/index.txt
