/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/index.txt

  • Committer: Martin Pool
  • Date: 2005-05-05 05:37:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050505053725-edabdafb18eb2472
- remove obsolete quickref

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/index.txt
 
1
Bazaar-NG
 
2
*********
 
3
 
 
4
..   These documents are formatted as ReStructuredText.  You can    ..
 
5
..   convert them to HTML, PDF, etc using the ``python-docutils``   ..
 
6
..   package.                                                       ..
 
7
 
 
8
 
 
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
 
12
development.
 
13
 
 
14
__ http://canonical.com/
 
15
 
 
16
 
 
17
**Note:** These documents are in a very preliminary state, and so may
 
18
be internally or externally inconsistent or redundant.  Comments are
 
19
still very welcome.  Please send them to <mbp@sourcefrog.net>.
 
20
 
 
21
 
 
22
For more information, see the homepage at http://bazaar-ng.org/
 
23
 
 
24
 
 
25
 
 
26
User documentation
 
27
------------------
 
28
 
 
29
* `Project overview/introduction <intro.html>`__
 
30
 
 
31
* `Command reference <cmdref.html>`__ -- intended to be user
 
32
  documentation, and gives the best overview at the moment of what the
 
33
  system will feel like to use.  Fairly complete.
 
34
 
 
35
* `FAQ <faq.html>`__ -- mostly user-oriented FAQ.
 
36
 
 
37
 
 
38
Requirements and general design
 
39
-------------------------------
 
40
 
 
41
* `Various purposes of a VCS <purpose.html>`__ -- taking snapshots and
 
42
  helping with merges is not the whole story.
 
43
 
 
44
* `Requirements <requirements.html>`__
 
45
 
 
46
* `Costs <costs.html>`__ of various factors: time, disk, network, etc.
 
47
 
 
48
* `Deadly sins <deadly-sins.html>`__ that gcc maintainers suggest we avoid.
 
49
 
 
50
* `Overview of the whole design <design.html>`__ and miscellaneous
 
51
  small design points.
 
52
 
 
53
* `File formats <formats.html>`__
 
54
 
 
55
* `Random observations <random.html>`__ that don't fit anywhere else yet.
 
56
 
 
57
 
 
58
 
 
59
Design of particular features
 
60
-----------------------------
 
61
 
 
62
* `Automatic generation of ChangeLogs <changelogs.html>`__
 
63
 
 
64
* `Cherry picking <cherry-picking.html>`__ -- merge just selected non-contiguous changes  from a branch.
 
65
 
 
66
* `Common changeset format <common-format.html>`__ for  interchange
 
67
  format between VCS.
 
68
 
 
69
* `Compression <compression.html>`__ of file text for more efficient storage.
 
70
 
 
71
* `Config specs <config-specs.html>`__ assemble a tree from several places.
 
72
 
 
73
* `Conflicts <conflicts.html>`_ that can occur during merge-like
 
74
  operations.
 
75
 
 
76
* `Ignored files <ignore.html>`__
 
77
 
 
78
* `Recovering from interrupted operations <interrupted.html>`__
 
79
 
 
80
* `Inventory command <inventory.html>`__
 
81
 
 
82
* `Branch joins <join-branches.html>`__ represent that all the changes
 
83
  from one branch are integrated into another.
 
84
 
 
85
* `Kill a version <kill-version.html>`__ to fix a broken commit or
 
86
  wrong message, or to
 
87
  remove confidential information from the history.
 
88
 
 
89
* `Hash collisions <hashes.html>`__ and weaknesses, and the security
 
90
  implications thereof.
 
91
 
 
92
* `Layers <layers.html>`__ within the design
 
93
 
 
94
* `Library interface <library-interface.html>`__ for Python.
 
95
 
 
96
* `Merge <merge.html>`__
 
97
 
 
98
* `Mirroring <mirroring.html>`__
 
99
 
 
100
* `Optional edit command <optional-edit.html>`__: sometimes people
 
101
  want to make the  working copy read-only, or not present at all.
 
102
 
 
103
* `Partial commits <partial-commit.html>`__
 
104
 
 
105
* `Patch pools <pool.html>`__ to efficiently store related branches.
 
106
 
 
107
* `Revfiles <revfile.html>`__ store the text history of files.
 
108
 
 
109
* `Revision syntax <revision-syntax.html>`__ -- ``hello.c@12``, etc.
 
110
 
 
111
* `Roll-up commits <rollup.html>`__ -- a single revision incorporates
 
112
  the changes from several others.
 
113
 
 
114
* `Scalability <scalability.html>`__
 
115
 
 
116
* `Security <security.html>`__
 
117
 
 
118
* `Shared branches <shared-branches.html>`__ maintained by more than
 
119
  one person
 
120
 
 
121
* `Supportability <supportability.html>`__ -- how to handle any bugs
 
122
  or problems in the field.
 
123
 
 
124
* `Place tags on revisions for easy reference <tagging.html>`__
 
125
 
 
126
* `Detecting unchanged files <unchanged.html>`__
 
127
   
 
128
* `Merging previously-unrelated branches <unrelated-merge.html>`__
 
129
 
 
130
* `Usability principles <usability.html>`__ (very small at the moment)
 
131
 
 
132
* `<use-cases.html>`__
 
133
 
 
134
* `<web-interface.html>`__
 
135
 
 
136
* `<workflow.html>`__ Modelling/controlling flow of patches.
 
137
 
 
138
* `<yaml.html>`__ --  Discussion of using YAML_ as a storage or transmission format.
 
139
 
 
140
.. _YAML: http://www.yaml.org/
 
141
 
 
142
 
 
143
 
 
144
Comparisons to other systems
 
145
----------------------------
 
146
 
 
147
* `Taxonomy <taxonomy.html>`__: basic questions a VCS must answer.
 
148
 
 
149
* `Bitkeeper <bitkeeper.html>`__, the proprietary system used by some
 
150
  kernel developers.
 
151
 
 
152
* `Aegis <compared-aegis.html>`__, a tool focussed on enforcing
 
153
  process and workflow.
 
154
 
 
155
* `Codeville <compared-codeville.html>`__ has an intruiging but
 
156
  scarcely-documented merge algorithm.
 
157
 
 
158
* `CVSNT <compared-cvsnt.html>`__, with more Windows support and some
 
159
  merge enhancements.
 
160
 
 
161
* `OpenCM <compared-opencm.html>`__, another hash-based tool with a
 
162
  good whitepaper.
 
163
 
 
164
* `PRCS <compared-prcs.html>`__, a non-distributed inventory-based tool.
 
165
 
 
166
* `GNU Arch <todo-from-arch.html>`__, with many pros and cons.
 
167
 
 
168
* `Darcs <darcs.html>`__, a merge-focussed tool with good usability.
 
169
 
 
170
* `Quilt <quilt.html>`__ -- Andrew Morton's patch scripts, popular with kernel maintainers.
 
171
 
 
172
* `Monotone <monotone.html>`__, Graydon Hoare's hash-based distributed system.
 
173
 
 
174
* `SVK <svk.html>`__ --     distributed operation stacked on Subversion.
 
175
 
 
176
* `Sun Teamware <compared-teamware.html>`__
 
177
 
 
178
 
 
179
Project management and organization
 
180
-----------------------------------
 
181
 
 
182
* `Notes on how to get a VCS adopted <adoption.html>`__
 
183
 
 
184
* `Thanks <thanks.html>`__ to various people
 
185
 
 
186
* `Extra commands <extra-commands.html>`__ for
 
187
  internal/developer/debugger use.
 
188
 
 
189
* `Choice of Python as a development language <python.html>`__