← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-25 03:40:12 UTC
  • mfrom: (4568.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090725034012-2fnpljnq7uvk9ss2
(igc) Support doc generation via sphinx

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/index-for-1x.txt
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 set up and use command aliases.
45
 
 
46
 
* `Running a Bazaar server <server.htm>`_
47
 
  
48
 
    How to run a server to allow remote access to Bazaar branches.
49
 
 
50
 
* `Running a Bazaar HTTP server <http_smart_server.htm>`_
51
 
 
52
 
    How to run a smart HTTP server to allow remote access to Bazaar branches.
53
 
 
54
 
* `Guidelines for modifying bzr <developers/index.htm>`_
55
 
 
56
 
    Guide to policies and tools for working on Bazaar itself.
57
 
 
58
 
This document automatically created based on output of **bzr help**:
59
 
 
60
 
* `Man page (help for bzr commands) <bzr_man.htm>`_
 
1
#################
 
2
Bazaar User Guide
 
3
#################
 
4
 
 
5
.. Please mark sections in included files as following:
 
6
..   level 1 ========
 
7
..   level 2 --------
 
8
..   level 3 ~~~~~~~~
 
9
..   level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
 
10
 
 
11
.. contents:: :depth: 3
 
12
 
 
13
 
 
14
Introduction
 
15
############
 
16
 
 
17
.. include:: introducing_bazaar.txt
 
18
.. include:: core_concepts.txt
 
19
.. include:: bazaar_workflows.txt
 
20
 
 
21
 
 
22
Getting started
 
23
###############
 
24
 
 
25
.. include:: installing_bazaar.txt
 
26
.. include:: entering_commands.txt
 
27
.. include:: getting_help.txt
 
28
.. include:: configuring_bazaar.txt
 
29
.. include:: using_aliases.txt
 
30
.. include:: plugins.txt
 
31
.. include:: zen.txt
 
32
 
 
33
 
 
34
Personal version control
 
35
########################
 
36
 
 
37
.. include:: solo_intro.txt
 
38
.. include:: starting_a_project.txt
 
39
.. include:: controlling_registration.txt
 
40
.. include:: reviewing_changes.txt
 
41
.. include:: recording_changes.txt
 
42
.. include:: browsing_history.txt
 
43
.. include:: releasing_a_project.txt
 
44
.. include:: undoing_mistakes.txt
 
45
 
 
46
 
 
47
Sharing with peers
 
48
##################
 
49
 
 
50
.. include:: partner_intro.txt
 
51
.. include:: branching_a_project.txt
 
52
.. include:: merging_changes.txt
 
53
.. include:: resolving_conflicts.txt
 
54
.. include:: annotating_changes.txt
 
55
 
 
56
 
 
57
Team collaboration, central style
 
58
#################################
 
59
 
 
60
.. include:: central_intro.txt
 
61
.. include:: publishing_a_branch.txt
 
62
.. include:: using_checkouts.txt
 
63
.. include:: working_offline_central.txt
 
64
.. include:: reusing_a_checkout.txt
 
65
 
 
66
 
 
67
Team collaboration, distributed style
 
68
#####################################
 
69
 
 
70
.. include:: distributed_intro.txt
 
71
.. include:: organizing_branches.txt
 
72
.. include:: using_gatekeepers.txt
 
73
.. include:: sending_changes.txt
 
74
 
 
75
 
 
76
Miscellaneous topics
 
77
####################
 
78
 
 
79
.. include:: part2_intro.txt
 
80
.. include:: adv_merging.txt
 
81
.. include:: shelving_changes.txt
 
82
.. include:: filtered_views.txt
 
83
.. include:: stacked.txt
 
84
.. include:: server.txt
 
85
.. include:: hooks.txt
 
86
.. include:: version_info.txt
 
87
 
 
88
 
 
89
A brief tour of some popular plugins
 
90
####################################
 
91
 
 
92
.. include:: bzrtools_plugin.txt
 
93
.. include:: svn_plugin.txt
 
94
.. include later looms_plugin.txt
 
95
 
 
96
 
 
97
Integrating Bazaar into your environment
 
98
########################################
 
99
 
 
100
.. include:: web_browsing.txt
 
101
.. include later - file_explorers.txt
 
102
.. include later - desktop_integration.txt
 
103
.. include later - editors_and_ides.txt
 
104
.. include later - email.txt
 
105
.. include:: bug_trackers.txt
 
106
 
 
107
 
 
108
Appendices
 
109
##########
 
110
 
 
111
.. include:: specifying_revisions.txt
 
112
.. include:: organizing_your_workspace.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
 
117
 
 
118
.. |--| unicode:: U+2014