← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/index.txt

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/index.txt
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
 
.. contents:: :depth: 2
14
 
.. sectnum::
15
 
 
16
 
 
17
 
Introduction
18
 
############
19
 
 
20
 
.. include:: introducing_bazaar.txt
21
 
.. include:: core_concepts.txt
22
 
.. include:: bazaar_workflows.txt
23
 
 
24
 
 
25
 
Getting started
26
 
###############
27
 
 
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
71
 
#####################################
72
 
 
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:: shelving_changes.txt
85
 
.. include:: filtered_views.txt
86
 
.. include:: stacked.txt
87
 
.. include:: server.txt
88
 
.. include:: hooks.txt
89
 
.. include:: version_info.txt
90
 
 
91
 
 
92
 
A brief tour of some popular plugins
93
 
####################################
94
 
 
95
 
.. include:: bzrtools_plugin.txt
96
 
.. include:: svn_plugin.txt
97
 
.. include later looms_plugin.txt
98
 
 
99
 
 
100
 
Integrating Bazaar into your environment
101
 
########################################
102
 
 
103
 
.. include:: web_browsing.txt
104
 
.. include later - file_explorers.txt
105
 
.. include later - desktop_integration.txt
106
 
.. include later - editors_and_ides.txt
107
 
.. include later - email.txt
108
 
.. include:: bug_trackers.txt
109
 
 
110
 
 
111
 
Appendices
112
 
##########
113
 
 
114
 
.. include:: specifying_revisions.txt
115
 
.. include:: organizing_your_workspace.txt
116
 
.. include:: shared_repository_layouts.txt
117
 
.. include:: setting_up_email.txt
118
 
.. include:: http_smart_server.txt
119
 
.. include:: writing_a_plugin.txt
120
 
 
121
 
.. |--| 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 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
This document automatically created based on output of **bzr help**:
 
55
 
 
56
* `Man page (help for bzr commands) <bzr_man.htm>`_