~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/index.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-08-17 07:52:09 UTC
  • mfrom: (1910.3.4 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20060817075209-e85a1f9e05ff8b87
(andrew) Trivial fixes to NotImplemented errors.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
############
38
 
 
39
 
* `Tutorial <tutorial.html>`_ |--| Explains how to use bzr.
40
 
  Loaded with examples.
41
 
 
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
 
###############
52
 
 
53
 
* `Conflict handling <conflicts.html>`_ |--| The various kind of conflicts
54
 
  you may encounter, and how to handle them.
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
 
 
79
 
* `Plugins <plugins.html>`_ |--| Information on how to use plugins in Bazaar.
80
 
 
81
 
* `Hooks <hooks.html>`_ |--| How to set up hooks that are executed on certain
82
 
  Bazaar operations.
83
 
 
84
 
* `Using aliases <using_aliases.html>`_ |--| How to set up 
85
 
  and use command aliases.
86
 
 
87
 
 
88
 
Integrating Bazaar With Other Systems
89
 
#####################################
90
 
 
91
 
* `Bug trackers <bug_trackers.html>`_ |--| Information on how to integrate with bug trackers.
92
 
 
93
 
* `Exporting version information <version_info.html>`_ |--| How to export version numbers to a build system.
94
 
 
95
 
.. |--| unicode:: U+2014
 
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
 
 
13
 
 
14
* `Tutorial <tutorial.htm>`_ 
 
15
  (wiki page: http://bazaar-vcs.org/IntroductionToBzr)
 
16
 
 
17
    Explains how to use bzr. Loaded with examples.
 
18
 
 
19
* `Configuration <configuration.htm>`_ 
 
20
  (wiki page: http://bazaar-vcs.org/ConfiguringBzr)
 
21
 
 
22
    Information on how to configure Bazaar
 
23
 
 
24
* `Setting up email <setting_up_email.htm>`_
 
25
  (wiki page: http://bazaar-vcs.org/BzrSettingEmail)
 
26
 
 
27
    The various ways that exist to tell Bazaar your email address for
 
28
    commits
 
29
 
 
30
* `Plugins <plugins.htm>`_
 
31
  (wiki page: http://bazaar-vcs.org/BzrPlugins)
 
32
    
 
33
    Information on how to use plugins in Bazaar
 
34
 
 
35
* `Specifying revision <specifying_revisions.htm>`_
 
36
  (wiki page: http://bazaar-vcs.org/BzrRevisionSpec)
 
37
 
 
38
    Description of the subarguments for ``-r`` as used by commands such as
 
39
    **bzr log** and **bzr merge**
 
40
 
 
41
* `Using aliases <using_aliases.htm>`_
 
42
  (wiki page: http://bazaar-vcs.org/CommandAliases)
 
43
 
 
44
    How to setup and use command aliases.
 
45
 
 
46
This document automatically created based on output of **bzr help**:
 
47
 
 
48
* `Man page (help for bzr commands) <bzr_man.htm>`_