~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/index.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-21 01:35:01 UTC
  • mfrom: (2733.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070821013501-op6nu6ae9u5gp56v
(Ian Clatworthy) Documentation organized into directories

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
======
2
 
Bazaar
3
 
======
4
 
-------------------
5
 
Documentation index
6
 
-------------------
7
 
 
8
 
These documents originally came from the Bazaar wiki hosted at
9
 
http://bazaar-vcs.org. The documents on the wiki take precedence 
10
 
in the event of a discrepancy between what is documented here 
11
 
and what is documented on the wiki.
12
 
 
 
1
=================
 
2
Bazaar User Guide
 
3
=================
 
4
 
 
5
.. Files are currently links but will become includes once the
 
6
.. content makes more sense as a whole.
 
7
.. Please mark sections in linked/included files as following:
 
8
..   level 1 ========
 
9
..   level 2 --------
 
10
..   level 3 ~~~~~~~~
 
11
..   level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
 
12
 
 
13
.. later contents::
 
14
.. later sectnum::
 
15
 
 
16
 
 
17
.. later Introduction
 
18
.. later ############
 
19
 
 
20
.. later include:: introducing_bazaar.txt
 
21
.. later include:: workflows.txt
 
22
 
 
23
 
 
24
Setting Up Bazaar
 
25
#################
 
26
 
 
27
.. later include:: download.txt
 
28
 
 
29
* `Introducing yourself <setting_up_email.html>`_ |--| The various ways that exist
 
30
  to tell Bazaar your email address for commits.
 
31
 
 
32
* `Using configuration files <configuration.html>`_ |--| Information on how to configure
 
33
  Bazaar.
 
34
 
 
35
 
 
36
Basic Topics
 
37
############
13
38
 
14
39
* `Tutorial <tutorial.html>`_ |--| Explains how to use bzr.
15
40
  Loaded with examples.
16
41
 
17
 
* `Configuration <configuration.html>`_ |--| Information on how to configure
18
 
  Bazaar.
19
 
 
20
 
* `Setting up email <setting_up_email.html>`_ |--| The various ways that exist
21
 
  to tell Bazaar your email address for commits.
 
42
* `Specifying revision identifiers <specifying_revisions.html>`_ |--| Description 
 
43
  of the subarguments for ``-r`` as used by commands such as
 
44
  **bzr log** and **bzr merge**.
 
45
 
 
46
* `Running a Bazaar server <server.html>`_ |--| How to run a server 
 
47
  to allow remote access to Bazaar branches.
 
48
 
 
49
 
 
50
Advanced Topics
 
51
###############
22
52
 
23
53
* `Conflict handling <conflicts.html>`_ |--| The various kind of conflicts
24
54
  you may encounter, and how to handle them.
25
55
 
 
56
* `Centralized workflow <centralized_workflow.html>`_ |--| How to use Bazaar in
 
57
  a centralized way like CVS or Subversion.
 
58
 
 
59
.. later include:: using_bound_branches.txt
 
60
.. later include:: shared_repositories.txt
 
61
 
 
62
 
 
63
Best Practices
 
64
##############
 
65
 
 
66
* `Running a Bazaar smart server <http_smart_server.html>`_ |--| How to run 
 
67
  a smart HTTP server to allow remote access to Bazaar branches.
 
68
 
 
69
* `Shared repositories layouts <shared_repository_layouts.html>`_ |--| The
 
70
  pros and cons of various repository layouts.
 
71
 
 
72
.. later include:: tracking_upstream.txt
 
73
.. later include:: useful_tips.txt
 
74
 
 
75
 
 
76
Extending Bazaar
 
77
################
 
78
 
26
79
* `Plugins <plugins.html>`_ |--| Information on how to use plugins in Bazaar.
27
80
 
28
 
* `Specifying revision <specifying_revisions.html>`_ |--| Description 
29
 
  of the subarguments for ``-r`` as used by commands such as
30
 
  **bzr log** and **bzr merge**.
31
 
 
32
81
* `Using aliases <using_aliases.html>`_ |--| How to set up 
33
82
  and use command aliases.
34
83
 
35
 
* `Running a Bazaar server <server.html>`_ |--| How to run a server 
36
 
  to allow remote access to Bazaar branches.
37
 
 
38
 
* `Running a Bazaar HTTP server <http_smart_server.html>`_ |--| How to run 
39
 
  a smart HTTP server to allow remote access to Bazaar branches.
40
 
 
41
 
* `Guidelines for modifying bzr <developers/index.html>`_ |--| Guide 
42
 
  to policies and tools for working on Bazaar itself.
43
 
 
44
 
 
45
 
This document automatically created based on output of **bzr help**:
46
 
 
47
 
* `Bazaar User Reference <bzr_man.html>`_
48
 
 
 
84
 
 
85
Integrating Bazaar With Other Systems
 
86
#####################################
 
87
 
 
88
* `Bug trackers <bug_trackers.html>`_ |--| Information on how to integrate with bug trackers.
 
89
 
 
90
* `Exporting version information <version_info.html>`_ |--| How to export version numbers to a build system.
49
91
 
50
92
.. |--| unicode:: U+2014