~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Ian Clatworthy
  • Date: 2007-11-14 03:50:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
=================
 
1
#################
2
2
Bazaar User Guide
3
 
=================
 
3
#################
4
4
 
5
5
.. Files are currently links but will become includes once the
6
6
.. content makes more sense as a whole.
10
10
..   level 3 ~~~~~~~~
11
11
..   level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
12
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
 
13
.. contents:: :depth: 2
 
14
.. sectnum::
 
15
 
 
16
 
 
17
Introduction
37
18
############
38
19
 
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
 
20
.. include:: introducing_bazaar.txt
 
21
.. include:: core_concepts.txt
 
22
.. include:: bazaar_workflows.txt
 
23
 
 
24
 
 
25
Getting started
51
26
###############
52
27
 
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
 
 
 
28
.. include:: installing_bazaar.txt
 
29
.. include:: using_bazaar.txt
 
30
.. later include:: configuring_bazaar.txt
 
31
.. include:: using_aliases.txt
 
32
.. include:: plugins.txt
 
33
 
 
34
 
 
35
Personal version control
 
36
########################
 
37
 
 
38
.. later include:: solo_workflow.txt
 
39
.. later include:: starting_a_project.txt
 
40
.. later include:: recording_changes.txt
 
41
.. later include:: browsing_history.txt
 
42
.. later include:: specifying_revisions.txt
 
43
.. later include:: releasing_a_project.txt
 
44
 
 
45
 
 
46
Sharing with peers
 
47
##################
 
48
 
 
49
.. later include:: partner_workflow.txt
 
50
.. later include:: branching_a_project.txt
 
51
.. later include:: merging.txt
 
52
.. later include:: managing_conflicts.txt
 
53
.. later include:: annotating_history.txt
 
54
 
 
55
 
 
56
Team collaboration, central style
 
57
#################################
 
58
 
 
59
.. later include:: centralized_workflow.txt
 
60
.. later include:: pushing_a_branch.txt
59
61
.. later include:: using_bound_branches.txt
 
62
 
 
63
 
 
64
Team collaboration, distributed style
 
65
#####################################
 
66
 
 
67
.. later include:: distributed_workflow.txt
60
68
.. later include:: shared_repositories.txt
61
69
 
62
70
 
63
 
Best Practices
 
71
Integrating bazaar with other systems
 
72
#####################################
 
73
 
 
74
.. include:: bug_trackers.txt
 
75
.. include:: version_info.txt
 
76
 
 
77
 
 
78
Best practices
64
79
##############
65
80
 
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
 
81
.. include:: shared_repository_layouts.txt
 
82
.. include:: server.txt
 
83
.. include:: hooks.txt
74
84
 
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.
 
85
.. Perhaps this ought to go in the User Reference?
 
86
.. include:: configuration.txt
 
87
 
 
88
 
 
89
Appendices
 
90
##########
 
91
 
 
92
.. include:: specifying_revisions.txt
 
93
.. include:: setting_up_email.txt
 
94
.. include:: authentication_conf.txt
 
95
.. include:: http_smart_server.txt
 
96
.. include:: writing_a_plugin.txt
94
97
 
95
98
.. |--| unicode:: U+2014