/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/contribution-quickstart.txt

  • Committer: Jelmer Vernooij
  • Date: 2018-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/contribution-quickstart.txt
1
 
Contributing to Breezy
 
1
Contributing to Bazaar
2
2
======================
3
3
 
4
4
Talk to us
5
5
----------
6
6
 
7
 
If you want to fix or improve something in Breezy, we want to help you.
 
7
If you want to fix or improve something in Bazaar, we want to help you.
8
8
You can ask at any time for help, on the list, on irc, or through a merge
9
9
proposal on Launchpad.
10
10
 
 
11
In particular, the rostered
 
12
`Patch Pilot <http://wiki.bazaar.canonical.com/PatchPilot>`_ 
 
13
is an experienced developer who will help you get your changes in, through
 
14
code review, advice, debugging, writing tests, or whatever it takes.
 
15
 
11
16
* `Bazaar mailing list <http://lists.ubuntu.com/mailman/listinfo/bazaar>`_
12
17
 
13
 
* IRC in channel ``#bzr`` on ``irc.freenode.net``
 
18
* IRC in channel ``#bzr`` on ``irc.ubuntu.com``
14
19
 
15
20
 
16
21
Starting
21
26
you should set it to "In Progress" and if you wish assign it to yourself.
22
27
 
23
28
You might like to start with a bug tagged `easy
24
 
<https://bugs.launchpad.net/brz/+bugs?field.tag=easy>`_.
 
29
<https://bugs.launchpad.net/bzr/+bugs?field.tag=easy>`_.
25
30
 
26
31
If you are wondering if your understanding of the bug is correct, or if the 
27
32
approach you have in mind is likely to work, feel to ask about it on the bug,
33
38
First, get a local copy of Bazaar::
34
39
 
35
40
   $ cd $HOME
36
 
   $ brz init-shared-repo brz
37
 
   $ cd brz
38
 
   $ brz branch lp:brz brz.dev
 
41
   $ bzr init-repo bzr
 
42
   $ cd bzr
 
43
   $ bzr branch lp:bzr bzr.dev
39
44
 
40
45
Now make your own branch; we recommend you include the bug number and also
41
46
a brief description::
42
47
 
43
 
   $ brz branch brz.dev 123456-status-speed
 
48
   $ bzr branch bzr.dev 123456-status-speed
44
49
 
45
50
and go ahead and commit in there.  Normally you should fix only one bug or
46
51
closely-related cluster of bugs per branch, to make reviews and merges
47
52
flow more smoothly.
48
53
 
49
 
You probably want this configuration in ``~/.config/breezy/locations.conf``::
50
 
 
51
 
    [/home/USER/brz]
52
 
    push_location = lp:~LAUNCHPAD_USER/brz/{branchname}
53
 
    public_branch = http://bazaar.launchpad.net/~LAUNCHPAD_USER/brz/{branchname}
 
54
For bugs that exist in older supported branches of bzr like 2.0 or 2.1,
 
55
you might want to fix the bug there so it can go into a bugfix release,
 
56
ie ::
 
57
 
 
58
   $ bzr branch lp:bzr/2.1 bzr.2.1
 
59
   $ bzr branch bzr.2.1 123458-2.1-status
 
60
 
 
61
You probably want this configuration in ``~/.bazaar/locations.conf``::
 
62
 
 
63
    [/home/USER/bzr]
 
64
    push_location = lp:~LAUNCHPAD_USER/bzr/
 
65
    push_location:policy = appendpath
 
66
    public_branch = http://bazaar.launchpad.net/~LAUNCHPAD_USER/bzr/
 
67
    public_branch:policy = appendpath
54
68
 
55
69
with your local and Launchpad usernames inserted.
56
70
 
62
76
After you've locally committed your changes, the configuration above
63
77
should be enough that you can push them to Launchpad with a simple ::
64
78
 
65
 
    $ brz push
 
79
    $ bzr push
66
80
 
67
81
 
68
82
Writing tests
83
97
 
84
98
To run the tests::
85
99
 
86
 
    $ ./brz selftest
 
100
    $ ./bzr selftest
87
101
 
88
102
Normally the tests will skip if some library dependencies are not present.
89
103
On Ubuntu, you can install them with this command (you must have source
90
104
repositories enabled in Software Sources)::
91
105
 
92
 
    $ sudo apt-get build-dep brz
 
106
    $ sudo apt-get build-dep bzr
93
107
 
94
108
To build the binary extensions::
95
109
 
102
116
-----------------
103
117
 
104
118
 
105
 
Then propose a merge into Breezy; for Breezy 3.0 and later you can use the ``brz
106
 
propose-merge`` command.  In the comment for your merge proposal please
 
119
Then propose a merge into bzr; for bzr 2.2 and later you can use the ``bzr
 
120
lp-propose-merge`` command.  In the comment for your merge proposal please
107
121
explain what you're trying to do and why.  For `example
108
122
<https://code.launchpad.net/~ian-clatworthy/bzr/whats-new-in-2.1/+merge/19677>`_:
109
123