← Back to branch summary

~cjwatson/bzr-builddeb/strip-message

« back to all changes in this revision

Viewing changes to doc/user_manual/index.rst

  • Committer: James Westby
  • Date: 2007-07-10 20:52:45 UTC
  • Revision ID: jw+debian@jameswestby.net-20070710205245-m8xq3c07ran3yj0k
Add the user manual.

  * The user manual is now the authoratitive documentation, rather than the
    rather short README.
  * It is only provided in html at the moment due to it being in several
    pieces and docutils not being able to link the pieces dynamically
    depending on the output type.
  * Thanks to Robey Pointer for the colour scheme.
  * Register the user manual with doc base rather than the README.

Other changes

  * Add dependency on bzrtools.
  * Bump required version of bzr for the testsuite failures that are fixed in
    0.18.
  * Actually call dh_install, and use it for the docs so that they can go in
    a subdir.
  * Add nocheck and notest DEBBUILDOPTS support to avoid running the testsuite
    during the build. My laptop is pleased.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/user_manual/index.rst
 
1
Working with Packages in Bazaar using bzr-builddeb
 
2
==================================================
 
3
 
 
4
Introduction
 
5
------------
 
6
 
 
7
Storing a package in a version control system can give many benefits,
 
8
particularly the record of changes, and the ability to work with multiple
 
9
branches and pull changes between them.
 
10
 
 
11
`Bazaar`_ is a modern distributed version control system that can be used
 
12
for this task. Bazaar aims to be easy to use, and provides all of the features
 
13
that you would expect of a version control system. However to ease working
 
14
with packages that are stored in version control other features need to be
 
15
provided. Bazaar has a plugin system that allows the set of commands to be
 
16
supplemented with others, and so a plugin exists to provide extra commands
 
17
useful for working with packages. This plugin is named `bzr-builddeb`.
 
18
 
 
19
This document aims to explain the features provided by the plugin, explain
 
20
some of the choices that are available when deciding how you want to work,
 
21
and provide examples of putting a package under version control and working
 
22
with it. It is not a tutorial on Bazaar itself, and it is assumed that you
 
23
know how to work with Bazaar already. If you do not then there are
 
24
`tutorials`_ available.
 
25
 
 
26
.. _Bazaar: http://www.bazaar-vcs.org/
 
27
.. _tutorials: http://doc.bazaar-vcs.org/bzr.dev/
 
28
 
 
29
If you do not yet have the plugin installed then you can see the `Installation`_
 
30
section for details on how to do this.
 
31
 
 
32
.. _Installation: installing.html
 
33
 
 
34
The plugin operates in several different `modes` depending on the type of
 
35
package and how you want to work. Each mode has its own documentation for
 
36
many tasks, so you should read the documentation for your mode. If you do
 
37
not know which mode you would like to use then you can either read about
 
38
each mode in its page, or use the `Mode Selector`_.
 
39
 
 
40
.. _Mode Selector: mode_selector.html
 
41
 
 
42
The modes are
 
43
 
 
44
  * `Normal mode`_
 
45
  * `Native mode`_
 
46
  * `Merge mode`_
 
47
  * `Export-upstream mode`_
 
48
  * `Split mode`_
 
49
 
 
50
.. _Normal mode: normal.html
 
51
.. _Merge mode: merge.html
 
52
.. _Native mode: native.html
 
53
.. _Split mode: split.html
 
54
.. _Export-upstream mode: export_upstream.html
 
55
 
 
56
The remainder of the documentation explains general features of the package.
 
57
These sections are
 
58
 
 
59
  * `Configuration Files`_
 
60
  * `Building a package`_
 
61
 
 
62
.. _Configuration Files: configuration.html
 
63
.. _Building a package: building.html 
 
64
 
 
65
Appendices
 
66
 
 
67
  * `License`_
 
68
 
 
69
.. _License: license.html
 
70
 
 
71
.. vim: set ft=rst tw=76 :
 
72