/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-12-10 03:51:46 UTC
  • mfrom: (7211.6.2 contributing-quickstart)
  • Revision ID: breezy.the.bot@gmail.com-20181210035146-vbpaqjpqnpuxs7gb
s/bzr/brz in the contributing quickstart guide.

Merged from https://code.launchpad.net/~jelmer/brz/contributing-quickstart/+merge/359486

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/contribution-quickstart.txt
1
 
Contributing to Bazaar
 
1
Contributing to Breezy
2
2
======================
3
3
 
4
4
Talk to us
5
5
----------
6
6
 
7
 
If you want to fix or improve something in Bazaar, we want to help you.
 
7
If you want to fix or improve something in Breezy, 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
 
21
21
you should set it to "In Progress" and if you wish assign it to yourself.
22
22
 
23
23
You might like to start with a bug tagged `easy
24
 
<https://bugs.launchpad.net/bzr/+bugs?field.tag=easy>`_.
 
24
<https://bugs.launchpad.net/brz/+bugs?field.tag=easy>`_.
25
25
 
26
26
If you are wondering if your understanding of the bug is correct, or if the 
27
27
approach you have in mind is likely to work, feel to ask about it on the bug,
33
33
First, get a local copy of Bazaar::
34
34
 
35
35
   $ cd $HOME
36
 
   $ bzr init-repo bzr
37
 
   $ cd bzr
38
 
   $ bzr branch lp:bzr bzr.dev
 
36
   $ brz init-repo brz
 
37
   $ cd brz
 
38
   $ brz branch lp:brz brz.dev
39
39
 
40
40
Now make your own branch; we recommend you include the bug number and also
41
41
a brief description::
42
42
 
43
 
   $ bzr branch bzr.dev 123456-status-speed
 
43
   $ brz branch brz.dev 123456-status-speed
44
44
 
45
45
and go ahead and commit in there.  Normally you should fix only one bug or
46
46
closely-related cluster of bugs per branch, to make reviews and merges
47
47
flow more smoothly.
48
48
 
49
 
For bugs that exist in older supported branches of bzr like 2.0 or 2.1,
50
 
you might want to fix the bug there so it can go into a bugfix release,
51
 
ie ::
52
 
 
53
 
   $ bzr branch lp:bzr/2.1 bzr.2.1
54
 
   $ bzr branch bzr.2.1 123458-2.1-status
55
 
 
56
49
You probably want this configuration in ``~/.bazaar/locations.conf``::
57
50
 
58
 
    [/home/USER/bzr]
59
 
    push_location = lp:~LAUNCHPAD_USER/bzr/
60
 
    push_location:policy = appendpath
61
 
    public_branch = http://bazaar.launchpad.net/~LAUNCHPAD_USER/bzr/
62
 
    public_branch:policy = appendpath
 
51
    [/home/USER/brz]
 
52
    push_location = lp:~LAUNCHPAD_USER/brz/{branchname}
 
53
    public_branch = http://bazaar.launchpad.net/~LAUNCHPAD_USER/brz/{branchname}
63
54
 
64
55
with your local and Launchpad usernames inserted.
65
56
 
71
62
After you've locally committed your changes, the configuration above
72
63
should be enough that you can push them to Launchpad with a simple ::
73
64
 
74
 
    $ bzr push
 
65
    $ brz push
75
66
 
76
67
 
77
68
Writing tests
92
83
 
93
84
To run the tests::
94
85
 
95
 
    $ ./bzr selftest
 
86
    $ ./brz selftest
96
87
 
97
88
Normally the tests will skip if some library dependencies are not present.
98
89
On Ubuntu, you can install them with this command (you must have source
99
90
repositories enabled in Software Sources)::
100
91
 
101
 
    $ sudo apt-get build-dep bzr
 
92
    $ sudo apt-get build-dep brz
102
93
 
103
94
To build the binary extensions::
104
95
 
111
102
-----------------
112
103
 
113
104
 
114
 
Then propose a merge into bzr; for bzr 2.2 and later you can use the ``bzr
115
 
lp-propose-merge`` command.  In the comment for your merge proposal please
116
 
explain what you're trying to do and why.  For `example
117
 
<https://code.launchpad.net/~ian-clatworthy/bzr/whats-new-in-2.1/+merge/19677>`_:
 
105
Then propose a merge into brz; you can use the ``brz lp-propose-merge`` command.
 
106
In the comment for your merge proposal please explain what you're trying
 
107
to do and why.  For
 
108
`example <https://code.launchpad.net/~ian-clatworthy/bzr/whats-new-in-2.1/+merge/19677>`_:
118
109
 
119
110
  As discussed on the mailing list, this patch adds a What's New document
120
111
  summarising the changes since 2.0.