~bzr-pqm/bzr/bzr.dev

2691.1.5 by Ian Clatworthy
Organise the user-guide topics into the desired structure
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
############
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
38
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
39
* `Tutorial <tutorial.html>`_ |--| Explains how to use bzr.
40
  Loaded with examples.
41
2691.1.5 by Ian Clatworthy
Organise the user-guide topics into the desired structure
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
###############
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
52
53
* `Conflict handling <conflicts.html>`_ |--| The various kind of conflicts
54
  you may encounter, and how to handle them.
55
2691.1.5 by Ian Clatworthy
Organise the user-guide topics into the desired structure
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
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
79
* `Plugins <plugins.html>`_ |--| Information on how to use plugins in Bazaar.
80
81
* `Using aliases <using_aliases.html>`_ |--| How to set up 
82
  and use command aliases.
83
2691.1.5 by Ian Clatworthy
Organise the user-guide topics into the desired structure
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.
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
91
92
.. |--| unicode:: U+2014