~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-11-04 18:51:39 UTC
  • mfrom: (2961.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20071104185139-kaio3sneodg2kp71
Authentication ring implementation (read-only)

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
 
.. contents:: :depth: 2
14
 
.. sectnum::
15
 
 
16
 
 
17
 
Introduction
 
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
18
37
############
19
38
 
20
 
.. include:: introducing_bazaar.txt
21
 
.. include:: core_concepts.txt
22
 
.. include:: bazaar_workflows.txt
23
 
 
24
 
 
25
 
Getting started
 
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
26
51
###############
27
52
 
28
 
.. include:: installing_bazaar.txt
29
 
.. include:: entering_commands.txt
30
 
.. include:: getting_help.txt
31
 
.. include:: configuring_bazaar.txt
32
 
.. include:: using_aliases.txt
33
 
.. include:: plugins.txt
34
 
.. include:: zen.txt
35
 
 
36
 
 
37
 
Personal version control
38
 
########################
39
 
 
40
 
.. include:: solo_intro.txt
41
 
.. include:: starting_a_project.txt
42
 
.. include:: controlling_registration.txt
43
 
.. include:: reviewing_changes.txt
44
 
.. include:: recording_changes.txt
45
 
.. include:: browsing_history.txt
46
 
.. include:: releasing_a_project.txt
47
 
.. include:: undoing_mistakes.txt
48
 
 
49
 
 
50
 
Sharing with peers
51
 
##################
52
 
 
53
 
.. include:: partner_intro.txt
54
 
.. include:: branching_a_project.txt
55
 
.. include:: merging_changes.txt
56
 
.. include:: resolving_conflicts.txt
57
 
.. include:: annotating_changes.txt
58
 
 
59
 
 
60
 
Team collaboration, central style
61
 
#################################
62
 
 
63
 
.. include:: central_intro.txt
64
 
.. include:: publishing_a_branch.txt
65
 
.. include:: using_checkouts.txt
66
 
.. include:: working_offline_central.txt
67
 
.. include:: reusing_a_checkout.txt
68
 
 
69
 
 
70
 
Team collaboration, distributed style
 
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
71
89
#####################################
72
90
 
73
 
.. include:: distributed_intro.txt
74
 
.. include:: organizing_branches.txt
75
 
.. include:: using_gatekeepers.txt
76
 
.. include:: sending_changes.txt
77
 
 
78
 
 
79
 
Miscellaneous topics
80
 
####################
81
 
 
82
 
.. include:: part2_intro.txt
83
 
.. include:: adv_merging.txt
84
 
.. include:: stacked.txt
85
 
.. include:: server.txt
86
 
.. include:: hooks.txt
87
 
.. include:: version_info.txt
88
 
 
89
 
 
90
 
A brief tour of some popular plugins
91
 
####################################
92
 
 
93
 
.. include:: bzrtools_plugin.txt
94
 
.. include:: svn_plugin.txt
95
 
.. include later looms_plugin.txt
96
 
 
97
 
 
98
 
Integrating Bazaar into your environment
99
 
########################################
100
 
 
101
 
.. include:: web_browsing.txt
102
 
.. include later - file_explorers.txt
103
 
.. include later - desktop_integration.txt
104
 
.. include later - editors_and_ides.txt
105
 
.. include later - email.txt
106
 
.. include:: bug_trackers.txt
107
 
 
108
 
 
109
 
Appendices
110
 
##########
111
 
 
112
 
.. include:: specifying_revisions.txt
113
 
.. include:: shared_repository_layouts.txt
114
 
.. include:: setting_up_email.txt
115
 
.. include:: http_smart_server.txt
116
 
.. include:: writing_a_plugin.txt
 
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.
117
94
 
118
95
.. |--| unicode:: U+2014