1
=== modified file '.bzrignore'
2
--- .bzrignore	2010-02-18 20:26:19 +0000
3
+++ .bzrignore	2011-01-11 23:17:27 +0000
4
@@ -1,1 +1,2 @@
5
1
./tags
1
./tags
6
2
_build
7
2
3
8
=== added directory 'docs'
9
=== added file 'docs/Makefile'
10
--- docs/Makefile	1970-01-01 00:00:00 +0000
11
+++ docs/Makefile	2011-01-11 23:17:27 +0000
12
@@ -0,0 +1,130 @@
13
1
# Makefile for Sphinx documentation
14
2
#
15
3
16
4
# You can set these variables from the command line.
17
5
SPHINXOPTS    =
18
6
SPHINXBUILD   = sphinx-build
19
7
PAPER         =
20
8
BUILDDIR      = _build
21
9
22
10
# Internal variables.
23
11
PAPEROPT_a4     = -D latex_paper_size=a4
24
12
PAPEROPT_letter = -D latex_paper_size=letter
25
13
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
26
14
27
15
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
28
16
29
17
help:
30
18
	@echo "Please use \`make <target>' where <target> is one of"
31
19
	@echo "  html       to make standalone HTML files"
32
20
	@echo "  dirhtml    to make HTML files named index.html in directories"
33
21
	@echo "  singlehtml to make a single large HTML file"
34
22
	@echo "  pickle     to make pickle files"
35
23
	@echo "  json       to make JSON files"
36
24
	@echo "  htmlhelp   to make HTML files and a HTML help project"
37
25
	@echo "  qthelp     to make HTML files and a qthelp project"
38
26
	@echo "  devhelp    to make HTML files and a Devhelp project"
39
27
	@echo "  epub       to make an epub"
40
28
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
41
29
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
42
30
	@echo "  text       to make text files"
43
31
	@echo "  man        to make manual pages"
44
32
	@echo "  changes    to make an overview of all changed/added/deprecated items"
45
33
	@echo "  linkcheck  to check all external links for integrity"
46
34
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
47
35
48
36
clean:
49
37
	-rm -rf $(BUILDDIR)/*
50
38
51
39
html:
52
40
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
53
41
	@echo
54
42
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
55
43
56
44
dirhtml:
57
45
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
58
46
	@echo
59
47
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
60
48
61
49
singlehtml:
62
50
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
63
51
	@echo
64
52
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
65
53
66
54
pickle:
67
55
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
68
56
	@echo
69
57
	@echo "Build finished; now you can process the pickle files."
70
58
71
59
json:
72
60
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
73
61
	@echo
74
62
	@echo "Build finished; now you can process the JSON files."
75
63
76
64
htmlhelp:
77
65
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
78
66
	@echo
79
67
	@echo "Build finished; now you can run HTML Help Workshop with the" \
80
68
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
81
69
82
70
qthelp:
83
71
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
84
72
	@echo
85
73
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
86
74
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
87
75
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/udd.qhcp"
88
76
	@echo "To view the help file:"
89
77
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/udd.qhc"
90
78
91
79
devhelp:
92
80
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
93
81
	@echo
94
82
	@echo "Build finished."
95
83
	@echo "To view the help file:"
96
84
	@echo "# mkdir -p $$HOME/.local/share/devhelp/udd"
97
85
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/udd"
98
86
	@echo "# devhelp"
99
87
100
88
epub:
101
89
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
102
90
	@echo
103
91
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
104
92
105
93
latex:
106
94
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107
95
	@echo
108
96
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
109
97
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
110
98
	      "(use \`make latexpdf' here to do that automatically)."
111
99
112
100
latexpdf:
113
101
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
114
102
	@echo "Running LaTeX files through pdflatex..."
115
103
	make -C $(BUILDDIR)/latex all-pdf
116
104
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
117
105
118
106
text:
119
107
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
120
108
	@echo
121
109
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
122
110
123
111
man:
124
112
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
125
113
	@echo
126
114
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
127
115
128
116
changes:
129
117
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
130
118
	@echo
131
119
	@echo "The overview file is in $(BUILDDIR)/changes."
132
120
133
121
linkcheck:
134
122
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
135
123
	@echo
136
124
	@echo "Link check complete; look for any errors in the above output " \
137
125
	      "or in $(BUILDDIR)/linkcheck/output.txt."
138
126
139
127
doctest:
140
128
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
141
129
	@echo "Testing of doctests in the sources finished, look at the " \
142
130
	      "results in $(BUILDDIR)/doctest/output.txt."
143
0
131
144
=== added directory 'docs/_static'
145
=== added directory 'docs/_templates'
146
=== added file 'docs/conf.py'
147
--- docs/conf.py	1970-01-01 00:00:00 +0000
148
+++ docs/conf.py	2011-01-11 23:17:27 +0000
149
@@ -0,0 +1,216 @@
150
1
# -*- coding: utf-8 -*-
151
2
#
152
3
# udd documentation build configuration file, created by
153
4
# sphinx-quickstart on Tue Jan 11 13:19:17 2011.
154
5
#
155
6
# This file is execfile()d with the current directory set to its containing dir.
156
7
#
157
8
# Note that not all possible configuration values are present in this
158
9
# autogenerated file.
159
10
#
160
11
# All configuration values have a default; values that are commented out
161
12
# serve to show the default.
162
13
163
14
import sys, os
164
15
165
16
# If extensions (or modules to document with autodoc) are in another directory,
166
17
# add these directories to sys.path here. If the directory is relative to the
167
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
168
19
#sys.path.insert(0, os.path.abspath('.'))
169
20
170
21
# -- General configuration -----------------------------------------------------
171
22
172
23
# If your documentation needs a minimal Sphinx version, state it here.
173
24
#needs_sphinx = '1.0'
174
25
175
26
# Add any Sphinx extension module names here, as strings. They can be extensions
176
27
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
177
28
extensions = []
178
29
179
30
# Add any paths that contain templates here, relative to this directory.
180
31
templates_path = ['_templates']
181
32
182
33
# The suffix of source filenames.
183
34
source_suffix = '.rst'
184
35
185
36
# The encoding of source files.
186
37
#source_encoding = 'utf-8-sig'
187
38
188
39
# The master toctree document.
189
40
master_doc = 'index'
190
41
191
42
# General information about the project.
192
43
project = u'udd'
193
44
copyright = u'2011, Barry Warsaw'
194
45
195
46
# The version info for the project you're documenting, acts as replacement for
196
47
# |version| and |release|, also used in various other places throughout the
197
48
# built documents.
198
49
#
199
50
# The short X.Y version.
200
51
version = '1.0'
201
52
# The full version, including alpha/beta/rc tags.
202
53
release = '1.0'
203
54
204
55
# The language for content autogenerated by Sphinx. Refer to documentation
205
56
# for a list of supported languages.
206
57
#language = None
207
58
208
59
# There are two options for replacing |today|: either, you set today to some
209
60
# non-false value, then it is used:
210
61
#today = ''
211
62
# Else, today_fmt is used as the format for a strftime call.
212
63
#today_fmt = '%B %d, %Y'
213
64
214
65
# List of patterns, relative to source directory, that match files and
215
66
# directories to ignore when looking for source files.
216
67
exclude_patterns = ['_build']
217
68
218
69
# The reST default role (used for this markup: `text`) to use for all documents.
219
70
#default_role = None
220
71
221
72
# If true, '()' will be appended to :func: etc. cross-reference text.
222
73
#add_function_parentheses = True
223
74
224
75
# If true, the current module name will be prepended to all description
225
76
# unit titles (such as .. function::).
226
77
#add_module_names = True
227
78
228
79
# If true, sectionauthor and moduleauthor directives will be shown in the
229
80
# output. They are ignored by default.
230
81
#show_authors = False
231
82
232
83
# The name of the Pygments (syntax highlighting) style to use.
233
84
pygments_style = 'sphinx'
234
85
235
86
# A list of ignored prefixes for module index sorting.
236
87
#modindex_common_prefix = []
237
88
238
89
239
90
# -- Options for HTML output ---------------------------------------------------
240
91
241
92
# The theme to use for HTML and HTML Help pages.  See the documentation for
242
93
# a list of builtin themes.
243
94
html_theme = 'default'
244
95
245
96
# Theme options are theme-specific and customize the look and feel of a theme
246
97
# further.  For a list of options available for each theme, see the
247
98
# documentation.
248
99
#html_theme_options = {}
249
100
250
101
# Add any paths that contain custom themes here, relative to this directory.
251
102
#html_theme_path = []
252
103
253
104
# The name for this set of Sphinx documents.  If None, it defaults to
254
105
# "<project> v<release> documentation".
255
106
#html_title = None
256
107
257
108
# A shorter title for the navigation bar.  Default is the same as html_title.
258
109
#html_short_title = None
259
110
260
111
# The name of an image file (relative to this directory) to place at the top
261
112
# of the sidebar.
262
113
#html_logo = None
263
114
264
115
# The name of an image file (within the static path) to use as favicon of the
265
116
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
266
117
# pixels large.
267
118
#html_favicon = None
268
119
269
120
# Add any paths that contain custom static files (such as style sheets) here,
270
121
# relative to this directory. They are copied after the builtin static files,
271
122
# so a file named "default.css" will overwrite the builtin "default.css".
272
123
html_static_path = ['_static']
273
124
274
125
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
275
126
# using the given strftime format.
276
127
#html_last_updated_fmt = '%b %d, %Y'
277
128
278
129
# If true, SmartyPants will be used to convert quotes and dashes to
279
130
# typographically correct entities.
280
131
#html_use_smartypants = True
281
132
282
133
# Custom sidebar templates, maps document names to template names.
283
134
#html_sidebars = {}
284
135
285
136
# Additional templates that should be rendered to pages, maps page names to
286
137
# template names.
287
138
#html_additional_pages = {}
288
139
289
140
# If false, no module index is generated.
290
141
#html_domain_indices = True
291
142
292
143
# If false, no index is generated.
293
144
#html_use_index = True
294
145
295
146
# If true, the index is split into individual pages for each letter.
296
147
#html_split_index = False
297
148
298
149
# If true, links to the reST sources are added to the pages.
299
150
#html_show_sourcelink = True
300
151
301
152
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
302
153
#html_show_sphinx = True
303
154
304
155
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
305
156
#html_show_copyright = True
306
157
307
158
# If true, an OpenSearch description file will be output, and all pages will
308
159
# contain a <link> tag referring to it.  The value of this option must be the
309
160
# base URL from which the finished HTML is served.
310
161
#html_use_opensearch = ''
311
162
312
163
# This is the file name suffix for HTML files (e.g. ".xhtml").
313
164
#html_file_suffix = None
314
165
315
166
# Output file base name for HTML help builder.
316
167
htmlhelp_basename = 'udddoc'
317
168
318
169
319
170
# -- Options for LaTeX output --------------------------------------------------
320
171
321
172
# The paper size ('letter' or 'a4').
322
173
#latex_paper_size = 'letter'
323
174
324
175
# The font size ('10pt', '11pt' or '12pt').
325
176
#latex_font_size = '10pt'
326
177
327
178
# Grouping the document tree into LaTeX files. List of tuples
328
179
# (source start file, target name, title, author, documentclass [howto/manual]).
329
180
latex_documents = [
330
181
  ('index', 'udd.tex', u'udd Documentation',
331
182
   u'Barry Warsaw', 'manual'),
332
183
]
333
184
334
185
# The name of an image file (relative to this directory) to place at the top of
335
186
# the title page.
336
187
#latex_logo = None
337
188
338
189
# For "manual" documents, if this is true, then toplevel headings are parts,
339
190
# not chapters.
340
191
#latex_use_parts = False
341
192
342
193
# If true, show page references after internal links.
343
194
#latex_show_pagerefs = False
344
195
345
196
# If true, show URL addresses after external links.
346
197
#latex_show_urls = False
347
198
348
199
# Additional stuff for the LaTeX preamble.
349
200
#latex_preamble = ''
350
201
351
202
# Documents to append as an appendix to all manuals.
352
203
#latex_appendices = []
353
204
354
205
# If false, no module index is generated.
355
206
#latex_domain_indices = True
356
207
357
208
358
209
# -- Options for manual page output --------------------------------------------
359
210
360
211
# One entry per manual page. List of tuples
361
212
# (source start file, name, description, authors, manual section).
362
213
man_pages = [
363
214
    ('index', 'udd', u'udd Documentation',
364
215
     [u'Barry Warsaw'], 1)
365
216
]
366
0
217
367
=== added file 'docs/getting.rst'
368
--- docs/getting.rst	1970-01-01 00:00:00 +0000
369
+++ docs/getting.rst	2011-01-11 23:17:27 +0000
370
@@ -0,0 +1,102 @@
371
1
==================
372
2
Getting the source
373
3
==================
374
4
375
5
Every source package in Ubuntu has an associated source branch on Launchpad.
376
6
These source branches are updated automatically by Launchpad, however if you
377
7
notice any version skew (e.g. version 1.7 is available as a source package but
378
8
only 1.5 as a source branch), see the `importer status page`_ for possible
379
9
failures.
380
10
381
11
If your source package is not yet available in Ubuntu, but it is available in
382
12
Debian, see below for importing the Debian source package into a local Bazaar
383
13
branch.
384
14
385
15
Either way, if you want to work on a source package in bzr then you should
386
16
create a shared repository on your machine in order to make future operations
387
17
more efficient. Once you have that then you can checkout branches in to it.
388
18
389
19
There are a couple of things that we do first in order to make things more
390
20
efficient later. Once you are used to the process you will learn when it makes
391
21
sense to skip these steps.
392
22
393
23
394
24
Creating a shared repository
395
25
============================
396
26
397
27
Say we want to work on the `foobar` source package.  We first create a shared
398
28
repository to hold our branches for this package.
399
29
400
30
We do this using the `bzr init-repo` command, passing it the directory name we
401
31
would like to use::
402
32
403
33
    $ bzr init-repo foobar
404
34
405
35
You will see that a `foobar` directory is created in your current working
406
36
area.  Now we need to change to this new directory for the rest of our work::
407
37
408
38
    $ cd foobar
409
39
410
40
411
41
Getting the trunk branch
412
42
========================
413
43
414
44
We use the `bzr branch` command to create a local branch of the package, and
415
45
the `ubuntu:` directory service (URL prefix) so that we can specify a shorter
416
46
URL::
417
47
418
48
    $ bzr branch ubuntu:foobar
419
49
420
50
You will need at least bzr 2.3 to utilize the `ubuntu:` prefix, otherwise
421
51
you'll use the `lp:` prefix for slightly longer URLs::
422
52
423
53
    $ bzr branch lp:ubuntu/foobar
424
54
425
55
This will create a branch in the new `foobar` directory.  It will contain the
426
56
contents of the source package for the current Ubuntu development release
427
57
(also called a *distroseries*).  If you prefer to name the resulting directory
428
58
after the current distroseries, do something like::
429
59
430
60
    $ bzr branch ubuntu:foobar natty
431
61
432
62
This puts the branch for the `foobar` package in Natty_ into the `natty`
433
63
directory.
434
64
435
65
436
66
Getting a branch for a particular release
437
67
=========================================
438
68
439
69
When you want to do something like a `stable release update`_ (SRU), or you
440
70
just want to examine the code in an old release, you may want to grab the
441
71
branch corresponding to a particular pocket in a particular Ubuntu release.
442
72
All package versions in all distroseries are exposed on Launchpad and
443
73
available through both the `ubuntu:` and `lp:` directory services.  For
444
74
example, to get the `foobar` package for Maverick *one* of the following:
445
75
446
76
    $ bzr branch ubuntu:m/foobar maverick
447
77
    $ bzr branch ubuntu:maverick/foobar maverick
448
78
    $ bzr branch lp:ubuntu/maverick/foobar maverick
449
79
450
80
451
81
Importing a Debian source package
452
82
=================================
453
83
454
84
If the package you want to work on is available in Debian but not Ubuntu, it's
455
85
still easy to import the code to a local bzr branch for development.  Let's
456
86
say you want to import the `newpackage` source package.  We'll start by
457
87
creating a shared repository as normal, but we also have to create a working
458
88
tree to which the source package will be imported::
459
89
460
90
    $ bzr init-repo newpackage
461
91
    $ cd new-package
462
92
    $ bzr init debian
463
93
    $ cd debian
464
94
    $ bzr import-dsc http://ftp.de.debian.org/debian/pool/main/n/newpackage/newpackage_1.0-1.dsc
465
95
466
96
As you can see, we just need to provide the remote location of the dsc file,
467
97
and bzr will do the rest.  You've now got a bzr source branch.
468
98
469
99
.. _`importer status page`: http://package-import.ubuntu.com/status
470
100
.. _Natty: https://wiki.ubuntu.com/NattyNarwhal
471
101
.. _`stable release update`: https://wiki.ubuntu.com/StableReleaseUpdates
472
102
.. _Maverick: https://wiki.ubuntu.com/MaverickMeerkat
473
0
103
474
=== added file 'docs/index.rst'
475
--- docs/index.rst	1970-01-01 00:00:00 +0000
476
+++ docs/index.rst	2011-01-11 23:17:27 +0000
477
@@ -0,0 +1,59 @@
478
1
==============================
479
2
Ubuntu Distributed Development
480
3
==============================
481
4
482
5
*Ubuntu Distributed Development* (UDD) is a technique for developing Ubuntu
483
6
 packages that uses tools, processes, and workflows similar to generic
484
7
 distributed version control system-based software development.  The dVCS used
485
8
 for UDD is Bazaar_.
486
9
487
10
UDD is an ongoing effort.  This means that some things will not yet be
488
11
documented, and some things that are documented will not yet work.  Volunteers
489
12
to help move this forward are of course, welcome.
490
13
491
14
This document contains a series of task-oriented guides for helping you with
492
15
common tasks.  Intrepid_ or later is currently required for these instructions
493
16
to work.
494
17
495
18
496
19
Related information
497
20
===================
498
21
499
22
The UDD project has a `presence on the Ubuntu wiki`_ which contains a
500
23
(probably out-of-sync) copy of this documentation, links to the bug tracker
501
24
and `project page on Launchpad`_, as well as links and minutes of public
502
25
meetings.
503
26
504
27
Once the relevant packages are installed, you might also find useful
505
28
information in `/usr/share/doc/bzr-builddeb/usr_manual/`.
506
29
507
30
508
31
Table of Contents
509
32
=================
510
33
511
34
.. toctree::
512
35
    :glob:
513
36
514
37
    setup
515
38
    getting
516
39
    working
517
40
    sponsorship
518
41
    uploading
519
42
    latest
520
43
    merging
521
44
    patchsys
522
45
    newpackage
523
46
524
47
525
48
Indices and tables
526
49
==================
527
50
528
51
* :ref:`genindex`
529
52
* :ref:`modindex`
530
53
* :ref:`search`
531
54
532
55
533
56
.. _`Bazaar`: http://bazaar.canonical.com/en/
534
57
.. _`Intrepid`: https://wiki.ubuntu.com/IntrepidIbex
535
58
.. _`presence on the Ubuntu wiki`: https://wiki.ubuntu.com/DistributedDevelopment
536
59
.. _`project page on Launchpad`: http://launchpad.net/udd
537
0
60
538
=== added file 'docs/latest.rst'
539
--- docs/latest.rst	1970-01-01 00:00:00 +0000
540
+++ docs/latest.rst	2011-01-11 23:17:27 +0000
541
@@ -0,0 +1,46 @@
542
1
==================
543
2
Getting The Latest
544
3
==================
545
4
546
5
If someone else has landed changes on a package, you will want to pull down
547
6
those changes in your own copies of the package branches.
548
7
549
8
550
9
Updating your main branch
551
10
=========================
552
11
553
12
Updating your copy of a branch that corresponds to the package in a particular
554
13
release is very simple, simply use `bzr pull` from the appropriate directory::
555
14
556
15
    $ cd foobar/natty
557
16
    $ bzr pull
558
17
559
18
This works wherever you have a checkout of a branch, so it will work for
560
19
things like branches of `maverick`, `hardy-proposed`, etc.
561
20
562
21
563
22
Getting the latest in to your working branches
564
23
==============================================
565
24
566
25
Once you have updated your copy of a distroseries branch, then you may want to
567
26
merge this in to your working branches as well, so that they are based on the
568
27
latest code.
569
28
570
29
You don't have to do this all the time though.  You can work on slightly older
571
30
code with no problems.  The disadvantage would come if you were working on
572
31
some code that someone else changed.  If you are not working on the latest
573
32
version then your changes may not be correct, and may even produce conflicts.
574
33
575
34
The merge does have to be done at some point though.  The longer it is left,
576
35
the harder may be, so doing it regularly should keep each merge simple.  Even
577
36
if there are many merges the total effort would hopefully be less.
578
37
579
38
To merge the changes you just need to use `bzr merge-package`, but you must
580
39
have committed your current work first.
581
40
582
41
    $ cd foobar/bug-12345
583
42
    $ bzr merge-package ../natty
584
43
585
44
Any conflicts will be reported, and you can fix them up.  To review the
586
45
changes that you just merged use `bzr diff`.  To undo the merge use `bzr
587
46
revert`.  Once you are happy with the changes then use `bzr commit`.
588
0
47
589
=== added file 'docs/merging.rst'
590
--- docs/merging.rst	1970-01-01 00:00:00 +0000
591
+++ docs/merging.rst	2011-01-11 23:17:27 +0000
592
@@ -0,0 +1,113 @@
593
1
=======
594
2
Merging
595
3
=======
596
4
597
5
Merging is one of the strengths of Bazaar, and something we do often in Ubuntu
598
6
development.  Updates can be merged from Debian, from a new upstream release,
599
7
and from other Ubuntu developers.
600
8
601
9
Doing it in bzr is pretty simple, and all based around the `bzr merge-package`
602
10
command.
603
11
604
12
The first thing to do is to check that the `package importer`_ hasn't failed
605
13
for the package you're going to work on.
606
14
607
15
When you are in any branch's working directory then you can merge from
608
16
another.  First check you have no uncommitted changes::
609
17
610
18
    $ bzr status
611
19
612
20
If that reports anything then you will either have to commit the changes,
613
21
revert them, or shelve them to come back to later.
614
22
615
23
616
24
Merging from Debian
617
25
===================
618
26
619
27
Next run `bzr merge-package` passing the URI of the branch to merge from.  For
620
28
instance, to merge from the version of the package in Debian Squeeze_ run::
621
29
622
30
    $ bzr merge-package lp:debian/squeeze/foobar
623
31
624
32
This will merge the changes since the last merge point and leave you with
625
33
changes to review.  This may cause some conflicts.  You can see all that
626
34
happened by running::
627
35
628
36
    $ bzr status
629
37
    $ bzr diff
630
38
631
39
If conflicts are reported then you need to edit those files to make them look
632
40
how they should, removing the *conflict markers*.  Once you have done, run::
633
41
634
42
    $ bzr resolve
635
43
    $ bzr conflicts
636
44
637
45
This will resolve any conflicted files that you fixed, and then tell you what
638
46
else you have to deal with.
639
47
640
48
Once any conflicts are resolved, and you have made any other changes that you
641
49
need, you will add a new changelog entry, and commit::
642
50
643
51
    $ dch -i
644
52
    $ bzr commit
645
53
646
54
as described earlier.
647
55
648
56
However, before you commit, it is always a good thing to check all the Ubuntu
649
57
changes by running::
650
58
651
59
    $ bzr diff -r tag:0.6.10-5
652
60
653
61
which will show the diff between the new Debian (0.6.10-5) and Ubuntu versions
654
62
(0.6.10-5ubuntu1).  In similar way you can compare to any other versions.  To
655
63
see all available version run::
656
64
657
65
    $ bzr tags
658
66
659
67
After testing and committing the merge, you will need to seek sponsorship or
660
68
upload to the archive in the normal way.
661
69
662
70
663
71
Merging a new upstream version
664
72
==============================
665
73
666
74
When upstream releases a new version (or you want to package a snapshot) then
667
75
you have to merge a tarball into your branch.
668
76
669
77
This is done using the `bzr merge-upstream` command.  From inside the branch
670
78
that you want to merge to you run something like::
671
79
672
80
    $ bzr merge-upstream --version 1.2 http://example.org/releases/foobar-1.2.tar.gz
673
81
674
82
This will download that tarball and merge it in to your branch, automatically
675
83
adding a `debian/changelog` entry for you.
676
84
677
85
The `--version` option is used to specify the upstream version that is being
678
86
merged in, as the command isn't able to infer that yet.
679
87
680
88
The last parameter is the location of the tarball that you are upgrading to;
681
89
this can either be a local filesystem path, or a http, ftp, sftp, etc. URI as
682
90
shown.  The command will automatically download the tarball for you.  If you
683
91
point to a `.tar.bz2` or similar tarball then it will recompress it as needed,
684
92
or convert it if you pass it a `.zip` or similar.  If your package is v3
685
93
(quilt) format and so can support `.tar.bz2` upstream tarballs then pass a
686
94
`--v3` option to prevent the repacking (this should be `automatically
687
95
detected`_).
688
96
689
97
The `merge-upstream` command will either tell you that it completed
690
98
successfully, or that there were conflicts.  Either way you will be able to
691
99
review the changes before committing as normal.
692
100
693
101
If you are merging an upstream release into an existing bzr branch that has
694
102
not previously used the UDD layout, `bzr merge-upstream` will fail with an
695
103
error that the tag for the previous upstream version is not available; the
696
104
merge can't be completed without knowing what base version to merge against.
697
105
To work around this, create a tag in your existing existing repo for the last
698
106
upstream version present there; e.g., if the last Ubuntu release was
699
107
*1.1-0ubuntu3*, create the tag *upstream-1.1* pointing to the bzr revision you
700
108
want to use as the tip of the upstream branch.
701
109
702
110
703
111
.. _`package importer`:  http://package-import.ubuntu.com/status/
704
112
.. _Squeeze: http://wiki.debian.org/DebianSqueeze
705
113
.. _`automatically detected`: https://bugs.edge.launchpad.net/bzr-builddeb/+bug/627718
706
0
114
707
=== added file 'docs/newpackage.rst'
708
--- docs/newpackage.rst	1970-01-01 00:00:00 +0000
709
+++ docs/newpackage.rst	2011-01-11 23:17:27 +0000
710
@@ -0,0 +1,171 @@
711
1
======================
712
2
Building a new package
713
3
======================
714
4
715
5
Let's say I have an upstream project that is not yet available for Ubuntu.  I
716
6
want to create a package from this project and make it available as a PPA_ so
717
7
that other people can more easily use the code.  This also makes a good first
718
8
step in contributing your package to universe_.
719
9
720
10
721
11
Example package
722
12
===============
723
13
724
14
I started with a Python library called `flufl.enum`_, which is a fairly
725
15
typical setuptools-based Python package.  Fortunately, it's also maintained in
726
16
Launchpad using Bazaar, so that makes bootstrapping much easier.  (TBD: add
727
17
instructions for using other upstream VCSs.)
728
18
729
19
Because we want to package the trunk branch, getting started is pretty
730
20
simple::
731
21
732
22
    $ bzr init-repo flufl.enum
733
23
    $ cd flufl.enum
734
24
    $ bzr branch lp:flufl.enum trunk
735
25
    $ bzr branch trunk debianize
736
26
    $ cd debianize
737
27
738
28
739
29
Bootstrapping
740
30
=============
741
31
742
32
You need to get the initial ``debian`` directory created somehow, along with
743
33
all the expected files inside that.  There are many ways to bootstrap that,
744
34
and hopefully there will eventually be `some convergence`_ in the methods,
745
35
especially if you're building standard Python setuptools-based libraries and
746
36
applications.
747
37
748
38
749
39
The bzr-builddeb way
750
40
--------------------
751
41
752
42
You could of course just use `dh_make(8)` to get things going, or you could
753
43
use `bzr dh-make`.  The latter might provide some benefits, and can be run
754
44
like so from inside your branch::
755
45
756
46
    $ bzr dh-make PKGNAME VERSION DOWNLOADURL
757
47
    $ bzr add debian
758
48
759
49
If you don't have a URL to download a tarball from, you'll need to create the
760
50
tarball locally first.  Use ``bzr dh-make --help`` for details on this command.
761
51
762
52
After you've created the ``debian`` directory template, be sure to ``bzr rm``
763
53
any ``debian`` files you don't need (e.g. the ``*.ex`` files), and edit files
764
54
such as ``debian/control``, ``debian/watch``, ``debian/copyright`` and
765
55
``debian/changelog``.  The following section may give you some hints about
766
56
that.
767
57
768
58
769
59
The stdeb way
770
60
-------------
771
61
772
62
Another way I've found useful for initializing the ``debian`` directory for
773
63
Python setuptools-based packages, is to use the stdeb_ package.  The full
774
64
documentation for this package is available on the `upstream home`_, but you
775
65
won't need all of the commands.  stdeb has a command that is *exactly* what
776
66
we're looking for!
777
67
778
68
In either case, start by putting this in your ``~/.pydistutils.cfg`` file::
779
69
780
70
    [global]
781
71
    command.packages:stdeb.command
782
72
783
73
784
74
Modern stdeb
785
75
~~~~~~~~~~~~
786
76
787
77
Here's how easy it is::
788
78
789
79
    $ python setup.py debianize
790
80
    $ bzr add debian
791
81
    $ bzr commit -m'Debianize'
792
82
793
83
794
84
We also need a ``debian/copyright`` file.  Normally, we'd use ``dh_make -c``
795
85
for that but again, that doesn't play nicely with UDD.  ``dh_make`` expects a
796
86
particular file system layout that we don't have.  No matter, we'll add the
797
87
copyright file manually::
798
88
799
89
    $ cp /usr/share/debhelper/dh_make/licenses/lgpl3 debian/copyright
800
90
    $ edit debian/copyright
801
91
    $ bzr add debian/copyright
802
92
    $ bzr commit -m'Added copyright file'
803
93
804
94
805
95
stdeb <= 0.5.1
806
96
~~~~~~~~~~~~~~
807
97
808
98
If you have an older version of stdeb, use this command to create the basic
809
99
``debian/`` directory layout::
810
100
811
101
    $ python setup.py sdist_dsc
812
102
813
103
This command leaves you with a ``deb_dist`` directory containing a
814
104
``flufl.enum_3.0.1`` directory.  Inside that is your ``debian/`` directory.
815
105
Because we're using UDD we don't care about anything else that ``sdist_dsc``
816
106
produces, so we can shuffle things around and remove the cruft.
817
107
818
108
    $ mv deb_dist/munepy-2.0.1/debian .
819
109
    $ rm -rf deb_dist
820
110
    $ bzr add debian
821
111
    $ bzr commit -m'Add debian directory'
822
112
823
113
824
114
pkgme
825
115
-----
826
116
827
117
pkgme_ is a new tool that makes it easy to Debianize a new package.  TBD:
828
118
describe how to use it.
829
119
830
120
831
121
debian/control file
832
122
===================
833
123
834
124
You probably want to edit the ``debian/control`` file at this point, adding
835
125
any information that's missing, or fixing incorrect default information.  For
836
126
example, I needed to modify the ``Maintainer`` and ``Description`` fields, and
837
127
add ``XS-Python-Version`` and ``Homepage`` fields.
838
128
839
129
Now we want to build the source package.  The easiest way to do that is with
840
130
the ``bzr-builddeb`` plugin, however this requires a valid ``debian/watch``
841
131
file so that builddeb can find the upstream tarball.  This really should match
842
132
the version of the checkout you've made.
843
133
844
134
845
135
debian/watch file
846
136
=================
847
137
848
138
Here for example is the ``debian/watch`` file I'm using::
849
139
850
140
    version=3
851
141
    http://pypi.python.org/packages/source/f/flufl.enum/flufl.enum-(.*).tar.gz
852
142
853
143
If your tarballs live on Launchpad, the ``debian/watch`` file is a little more
854
144
complicated (see `Question 21146`_ and `Bug 231797`_ for why this is).  In
855
145
that case, use something like::
856
146
857
147
    version=3
858
148
    https://launchpad.net/flufl.enum/+download http://launchpad.net/flufl.enum/.*/flufl.enum-(.+).tar.gz
859
149
860
150
So, then it's a matter of...::
861
151
862
152
    $ bzr add debian/watch
863
153
    $ bzr commit -m'added debian/watch file'
864
154
865
155
866
156
Building the source package
867
157
===========================
868
158
869
159
Now we can build the source package and publish the package as we normally
870
160
would, with ``bzr bd -S`` and ``dput``.
871
161
872
162
873
163
.. _PPA: https://help.launchpad.net/Packaging/PPA
874
164
.. _universe: https://wiki.ubuntu.com/MOTU/GettingStarted
875
165
.. _`flufl.enum`: http://launchpad.net/flufl.enum
876
166
.. _`some convergence`: http://launchpad.net/bugs/545361
877
167
.. _stdeb: http://packages.ubuntu.com/lucid/python-stdeb
878
168
.. _`upstream home`: http://github.com/astraw/stdeb#the-commands
879
169
.. _pkgme: https://launchpad.net/pkgme
880
170
.. _`Question 21146`: https://answers.launchpad.net/launchpad/+question/21146
881
171
.. _`Bug 231797`: https://launchpad.net/bugs/231797
882
0
172
883
=== added file 'docs/patchsys.rst'
884
--- docs/patchsys.rst	1970-01-01 00:00:00 +0000
885
+++ docs/patchsys.rst	2011-01-11 23:17:27 +0000
886
@@ -0,0 +1,188 @@
887
1
===========================
888
2
Working with a patch system
889
3
===========================
890
4
891
5
Many existing packages that have changes from upstream express those changes
892
6
using a `patch system`_, of which there are several to choose from.  Usually,
893
7
when you make an additional change to a package, you'll want to add a patch
894
8
file to the patch system being used, rather than editing the source code in
895
9
place.  Note however that it is considered bad practice to add a patch system
896
10
to a package that does not already have one.  In that case, either coordinate
897
11
with the Debian maintainer, or edit the files in place.  You can find out if
898
12
your package has a patch system by using the ``what-patch`` command (from the
899
13
``ubuntu-dev-tools`` package).
900
14
901
15
Although UDD, and in particular `Bazaar looms`_ makes it pretty easy to keep
902
16
individual patches separated, if you're submitting changes to be uploaded,
903
17
you're currently better off playing along with the package's patch system.
904
18
*You will want at least bzr loom version 2.2.1dev, otherwise you'll have
905
19
problems pushing and pulling your threads to Launchpad.* Do ``bzr plugins`` to
906
20
find the version you're using.
907
21
908
22
Here are some guidelines that I've found helpful.  Clearly the existing tools
909
23
can be improved, but for now this seems to work well enough.  This assumes
910
24
you're using looms to develop your patch, and that the package itself uses the
911
25
quilt_ patch system.
912
26
913
27
One important thing to know: all source branches reflect the tree after a
914
28
``quilt push -a``.  In other words, when you branch a source branch, you get
915
29
the tree with all patches applied, ready for you to jump right into hacking.
916
30
You do not need to ``quilt push -a`` manually, and in fact, you'll get a tree
917
31
with lots of distracting modifications if you push or pop all the changes.  Or
918
32
to put it another way, once you have a branch, jump right in!
919
33
920
34
921
35
Develop your patch
922
36
==================
923
37
924
38
Start as you normally would with UDD and looms::
925
39
926
40
    $ bzr init-repo foobar
927
41
    $ cd foobar
928
42
    $ bzr branch ubuntu:foobar (or lp:ubuntu/foobar)
929
43
    $ bzr branch foobar myfix
930
44
    $ cd myfix
931
45
    $ bzr loomify --base trunk
932
46
    $ bzr create-thread sourcefix
933
47
934
48
Now that you are in the ``sourcefix`` thread, just edit the source code,
935
49
making whatever changes you need to fix the bug.  Don't worry about the patch
936
50
system at this point, at least until you are happy with your changes.  If
937
51
someone else pushes changes to the package while you're working on it, just
938
52
``bzr down-thread`` to ``trunk``, pull the updates, and ``bzr up-thread
939
53
--auto`` back to the ``sourcefix`` thread, resolving any conflicts along the
940
54
way.  You can periodically commit your changes, ``bzr record`` and push them
941
55
to Launchpad as you go, of course linking your branch to the bug in Launchpad.
942
56
So far, it's just normal development with looms.
943
57
944
58
Once you're happy with your changes, you need to essentially import your
945
59
thread's changes into a quilt patch.  This is fairly easy to do::
946
60
947
61
    $ bzr create-thread quiltfix
948
62
    $ bzr diff -rthread:trunk..thread:sourcefix | quilt import -p0 -P myfix /dev/stdin
949
63
    $ bzr add debian/patches/myfix
950
64
    $ quilt push
951
65
    $ quilt pop
952
66
    $ bzr commit
953
67
954
68
Why the last push/pop before the commit?  The push gets the imported changes
955
69
into the quilt patch, but also leaves the tree modified, so you'll essentially
956
70
have the changes both in the ``debian/`` directory and in the tree.  The pop
957
71
undoes the tree changes (which are also available in the ``sourcefix``
958
72
thread), but leaves the quilt change available.  A ``bzr commit`` at this
959
73
point gives you a thread with just the changes to ``debian/``.
960
74
961
75
962
76
Problems
963
77
========
964
78
965
79
The problem comes when you want to modify the patch, e.g.::
966
80
967
81
    $ bzr down-thread
968
82
    <hack, commit>
969
83
970
84
This does *not* work well::
971
85
972
86
    $ bzr up-thread
973
87
974
88
You'd expect at this point to be able to ``quilt fold`` your new changes to
975
89
update your ``myfix`` quilt patch, but in fact, this doesn't work.  You can
976
90
end up with difficult to resolve conflicts, patch failures and rejections.  My
977
91
recommendation is that when you make changes to your ``sourcefix`` thread,
978
92
blow away your ``quiltfix`` thread and regenerate it.  Looms make this easy::
979
93
980
94
    $ bzr up-thread
981
95
    $ bzr revert
982
96
    $ bzr combine-thread --force (throws away your quiltfix changes)
983
97
    $ bzr create-thread quiltfix
984
98
    $ bzr diff -rthread:trunk..thread:sourcefix | quilt import -p0 -P myfix /dev/stdin
985
99
    etc...
986
100
987
101
So you've thrown away the ``quiltfix`` thread, and recreated it, with your
988
102
updated ``sourcefix`` changes.
989
103
990
104
991
105
Gotchas
992
106
=======
993
107
994
108
One thing to keep in mind is that quilt uses a hidden ``.pc`` directory to
995
109
record its status.  This directory is under version control in all source
996
110
branches.  *Watch out* for changes to the ``.pc`` directory that are unrelated
997
111
(or more accurately, uninteresting) to your patch.  This can happen because
998
112
the UDD source branch importer `currently includes any existing .pc
999
113
directory`_ in the imported branch.  This can cause conflicts, or other
1000
114
unwanted or unknown changes because you've essentially got two conflicting
1001
115
version control systems competing for the same thing (i.e. bzr and quilt3).
1002
116
For now, the best recommendation is to revert any changes to the ``.pc``
1003
117
directory in your branch.
1004
118
1005
119
1006
120
Publishing your changes
1007
121
=======================
1008
122
1009
123
It's actually easier at this point to generate a diff for attaching to the bug
1010
124
report.  Just::
1011
125
1012
126
    $ bzr up-thread -auto
1013
127
    $ bzr diff -rthread: > mypatch.diff
1014
128
1015
129
The differences between the ``quiltfix`` thread and the ``sourcefix`` thread
1016
130
are the interesting bits, and totally appropriate for committing and upload.
1017
131
Because of the way looms interacts with Launchpad, you can still link your
1018
132
branch to the bug and request a merge proposal, but understand that the diff
1019
133
will include all changes between ``quiltfix`` (top) and ``trunk`` (bottom)
1020
134
threads.  So the merge proposal will include the changes in the ``debian/``
1021
135
directory, *and* the changes in the source tree.  As long as you and your
1022
136
reviewer understands this, you should be okay, but it can be confusing at
1023
137
first.
1024
138
1025
139
If you need a sponsor to merge and upload your changes, one thing they *do
1026
140
not* want to do is::
1027
141
1028
142
    $ bzr branch ubuntu:foobar
1029
143
    $ cd foobar
1030
144
    $ bzr merge lp:~you/ubuntu/natty/foobar/yourfix
1031
145
1032
146
Much badness (in the form of infinite *maximum recursion depth* exceptions)
1033
147
ensues.  Yes, we need to file a bug on that.
1034
148
1035
149
1036
150
edit-patch
1037
151
==========
1038
152
1039
153
``edit-patch`` is a nice little wrapper script that comes as part of the
1040
154
``ubuntu-dev-tools`` package.  It pretty much hides the nasty details of
1041
155
dealing with the patch system specifically.  For example, while the above
1042
156
works well if your package is using quilt already, you'll have to adjust the
1043
157
workflow, perhaps significantly, to work with `a different patch system`_.  In
1044
158
theory ``edit-patch`` should solve this, but there are currently two blockers.
1045
159
1046
160
  * By default, ``bzr diff`` produces a ``-p0`` patch, but ``edit-patch``
1047
161
    defers to the underlying patch system's default.  For quilt, this is
1048
162
    ``-p1``.  ``quilt import`` takes a ``-p`` argument to specify the prefix
1049
163
    level, but this isn't yet exposed in ``edit-patch``.  If you're
1050
164
    adventurous, try changing the ``bzr diff`` command above to specify the
1051
165
    proper prefixes using its ``-p`` option.
1052
166
  * By default, ``edit-patch`` requires a path to an existing patch file, but
1053
167
    it's more convenient to pipe the output of ``bzr diff`` to the stdin of
1054
168
    ``edit-patch``, as shown above.  The alternative would be to save the diff
1055
169
    in a temporary file, and then point ``edit-patch`` to this temporary file.
1056
170
1057
171
1058
172
Future
1059
173
======
1060
174
1061
175
Ideally, it would be nice to add a ``bzr edit-patch`` or some such command
1062
176
which does the whole loom -> patch system import.  At least ``edit-patch``
1063
177
could grow a ``-p`` and ``-P`` option, as well as read from stdin.  Stay
1064
178
tuned, or get involved!
1065
179
1066
180
There's now `a bug` that tracks this.
1067
181
1068
182
1069
183
.. _`patch system`: https://wiki.ubuntu.com/DistributedDevelopment/Documentation/PatchSystem/PackagingGuide/PatchSystems
1070
184
.. _`Bazaar looms`: https://launchpad.net/bzr-loom
1071
185
.. _quilt: http://www.wzdftpd.net/blog/index.php?2008/02/05/3-quilt-a-patch-management-system-how-to-survive-with-many-patches
1072
186
.. _`currently includes any existing .pc directory`: https://bugs.launchpad.net/udd/+bug/672740
1073
187
.. _`a different patch system`: http://wiki.debian.org/debian/patches
1074
188
.. _`a bug`: https://launchpad.net/bugs/620721
1075
0
189
1076
=== added file 'docs/setup.rst'
1077
--- docs/setup.rst	1970-01-01 00:00:00 +0000
1078
+++ docs/setup.rst	2011-01-11 23:17:27 +0000
1079
@@ -0,0 +1,48 @@
1080
1
==========
1081
2
Setting up
1082
3
==========
1083
4
1084
5
1085
6
Installing Packages
1086
7
===================
1087
8
1088
9
You will first need to install packages to make the tools available to you.
1089
10
The packages you need to install are `bzr` and `bzr-builddeb`::
1090
11
1091
12
    $ sudo aptitude install bzr bzr-builddeb
1092
13
1093
14
1094
15
Introducing yourself to bzr
1095
16
===========================
1096
17
1097
18
In order to properly attribute your work to you bzr needs to know your name
1098
19
and email address, which you can specify with the `bzr whoami` command::
1099
20
1100
21
    $ bzr whoami "James Westby <james.westby@ubuntu.com>"
1101
22
1102
23
You don't have to give your real name, and you don't have to give your
1103
24
email address, but doing so is a good idea for Ubuntu development.
1104
25
1105
26
1106
27
Telling bzr about your launchpad account
1107
28
========================================
1108
29
1109
30
bzr can work better with Launchpad_ if you tell it what your Launchpad
1110
31
username is with the `bzr launchpad-login` command::
1111
32
1112
33
    $ bzr launchpad-login james-w
1113
34
1114
35
where you should substitute your own Launchpad id for `james-w`.  If you don't
1115
36
have a Launchpad account you can easily `create one`_.  If you don't know your
1116
37
Launchpad id, you can find out what this is by going to
1117
38
https://launchpad.net/people/+me and looking at the part after `~` in the URL.
1118
39
1119
40
The `launchpad-login` command will fail if you haven't set up an SSH key in
1120
41
Launchpad yet, but it is `easy to do that`_.
1121
42
1122
43
Now you are ready to use bzr to do Ubuntu development.
1123
44
1124
45
1125
46
.. _Launchpad: http://launchpad.net
1126
47
.. _`create one`: https://launchpad.net/+login
1127
48
.. _`easy to do that`: https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair
1128
0
49
1129
=== added file 'docs/sponsorship.rst'
1130
--- docs/sponsorship.rst	1970-01-01 00:00:00 +0000
1131
+++ docs/sponsorship.rst	2011-01-11 23:17:27 +0000
1132
@@ -0,0 +1,110 @@
1133
1
===================
1134
2
Seeking Sponsorship
1135
3
===================
1136
4
1137
5
If you have made a change to the package and you do not have rights to upload
1138
6
the package then you will need to seek a sponsor.
1139
7
1140
8
Note that many sponsorships are still done via debdiffs, and some sponsors
1141
9
will prefer that, so you may wish to attach a diff to the bug as well.
1142
10
1143
11
1144
12
Linking to bugs
1145
13
===============
1146
14
1147
15
You will need a bug report to seek sponsorship, and you should refer to this
1148
16
issue from your `debian/changelog`.  Fill in the changelog entry by running
1149
17
`dch -i` and add the `LP: #12345` entry as normal.  For example::
1150
18
1151
19
    foobar (1.0-2ubuntu1) natty; urgency=low
1152
20
1153
21
      * debian/control: Fixed a crash in the baz submodule  (LP: #12345)
1154
22
1155
23
     -- Barry Warsaw <barry@ubuntu.com>  Mon, 04 Jan 2010 15:33:52 -0500
1156
24
1157
25
The format of the bug reference must match exactly; if you leave out the space
1158
26
or the `#` then the issue will not be closed correctly once your change
1159
27
lands.  You may also want to use the `--fixes` option on the `bzr commit`
1160
28
command to link your branch to the bug report::
1161
29
1162
30
    $ bzr commit --fixes lp:12345
1163
31
1164
32
Now, when you push the branch to Launchpad it will link the branch to the bug
1165
33
report.
1166
34
1167
35
It is not critical to have a link to a bug for every change you make,
1168
36
but if you are fixing reported bugs then linking to them will be useful.
1169
37
1170
38
1171
39
Pushing to Launchpad
1172
40
====================
1173
41
1174
42
Now you should push the branch to Launchpad so that it can be retrieved
1175
43
by others. You do this by pushing it to a branch under your user id::
1176
44
1177
45
    $ bzr push lp:~james-w/ubuntu/natty/foobar/bug-12345
1178
46
1179
47
where you substitute your Launchpad user id for *james-w*, and the Ubuntu
1180
48
release code name you're targeting for *natty*.  If you linked a commit to a
1181
49
bug number as shown above, then the Launchpad page for the bug will include a
1182
50
link to your branch.
1183
51
1184
52
However, this usually isn't enough to get Ubuntu developers to review your
1185
53
change.  You should next submit a *merge proposal* so that the developers can
1186
54
find your fix and review it.
1187
55
1188
56
To do this open your page in a browser, e.g.
1189
57
1190
58
    $ bzr lp-open
1191
59
1192
60
if that fails, then you can use
1193
61
1194
62
    $ xdg-open https://code.launchpad.net/~james-w/ubuntu/natty/foobar/bug-12345
1195
63
1196
64
where most of the URL matches what you used for `bzr push`.  On this page,
1197
65
you'll see a link that says *Propose for merging into another branch*.  Type
1198
66
in an explanation of your change in the *Initial Comment* box.  Lastly, click
1199
67
*Propose Merge* to complete the process.
1200
68
1201
69
Merge proposals to package source branches will automatically subscribe the
1202
70
`~ubuntu-branches` team, which should be enough to reach an Ubuntu developer
1203
71
who can review and sponsor your package change.
1204
72
1205
73
1206
74
Generating a debdiff
1207
75
====================
1208
76
1209
77
As noted above, many sponsors still prefer reviewing a *debdiff* attached to
1210
78
bug reports instead of a merge proposal.  If you're requested to include a
1211
79
debdiff, you can generate one like this (from inside your `bug-12345`
1212
80
branch)::
1213
81
1214
82
    $ bzr diff -rbranch:../natty
1215
83
1216
84
Another way is to is to open the merge proposal and download the diff.
1217
85
1218
86
You should ensure that diff has the changes you expect, no more and no less.
1219
87
Name the diff appropriately e.g. foobar-12345.debdiff and attach it to the bug
1220
88
report.
1221
89
1222
90
1223
91
Dealing with feedback from sponsors
1224
92
===================================
1225
93
1226
94
If a sponsor reviews your change and asks you to change something then you can
1227
95
do this fairly easily.  Simply go to the branch that you were working in
1228
96
before and make the changes requested, and then commit::
1229
97
1230
98
    $ bzr commit
1231
99
1232
100
Now you can push your changes up to Launchpad as before, but bzr will have
1233
101
remembered where you pushed to, so you can simply run::
1234
102
1235
103
    $ bzr push
1236
104
1237
105
You can then reply to the request for changes explaining what you changed, and
1238
106
asking for re-review, or you can reply on the merge proposal page in
1239
107
Launchpad.
1240
108
1241
109
Note if you are sponsored via debdiff attached to a bug report you need to
1242
110
manually update it as described above.
1243
0
111
1244
=== added file 'docs/uploading.rst'
1245
--- docs/uploading.rst	1970-01-01 00:00:00 +0000
1246
+++ docs/uploading.rst	2011-01-11 23:17:27 +0000
1247
@@ -0,0 +1,117 @@
1248
1
===================
1249
2
Uploading a package
1250
3
===================
1251
4
1252
5
Once your merge proposal is reviewed and approved, you will want to upload
1253
6
your package, either to the archive (if you have permission) or to your
1254
7
*Personal Package Archive* (PPA).  You might also want to do an upload if you
1255
8
are sponsoring someone else's changes.
1256
9
1257
10
1258
11
Uploading a change made by you
1259
12
==============================
1260
13
1261
14
When you have a branch with a change that you would like to upload you need to
1262
15
get that change back on to the main branch and then upload it.
1263
16
1264
17
First, you need to check that you have the latest version of the package in
1265
18
your checkout of the development package::
1266
19
1267
20
    $ cd foobar/natty
1268
21
    $ bzr pull
1269
22
1270
23
If this pulls in any changes that may have been committed while you were
1271
24
working on your fix.  From here, you have several options.  If the changes on
1272
25
the trunk are large, and it will take a while to merge them and test the
1273
26
package, then you can merge them back in to your work branch to do this.  If
1274
27
not, then you can carry on merging your work branch in to the main one::
1275
28
1276
29
    $ bzr merge-package ../bug-12345
1277
30
1278
31
This will merge the two trees, possibly producing conflicts, which you'll need
1279
32
to resolve manually.
1280
33
1281
34
Next you should make sure the `debian/changelog` is as you would like, with
1282
35
the correct distribution, version number, etc.
1283
36
1284
37
Once that is done you should review the change you are about to commit
1285
38
with `bzr diff`.  This should show you the same changes as a debdiff would
1286
39
before you upload the source package.
1287
40
1288
41
The next step is to build and test the modified source package as you normally
1289
42
would.  Once you are happy with the upload then you should `dput` the
1290
43
source package.  For example, if you want to upload your changes to your PPA,
1291
44
then you'd do::
1292
45
1293
46
    $ dput ppa:me/myppa foobar_1.0-2ubuntu1.dsc
1294
47
1295
48
You might want to do one more `bzr commit` to make sure all your changes are
1296
49
committed in your working tree.
1297
50
1298
51
The last step is to mark the change as being the same as the source package
1299
52
that was uploaded, so run::
1300
53
1301
54
    $ bzr mark-uploaded
1302
55
1303
56
This also tells the package importer that what is in bzr is the same as in the
1304
57
archive.
1305
58
1306
59
Now you can push the changes back to Launchpad::
1307
60
1308
61
    $ bzr push ubuntu:foobar
1309
62
1310
63
(Change the destination if you are uploading an SRU or similar.)
1311
64
1312
65
You are now free to delete your feature branch, as it is merged, and can
1313
66
be recovered if needed.
1314
67
1315
68
1316
69
Sponsoring a change
1317
70
===================
1318
71
1319
72
Sponsoring a change is just like the above procedure, but instead of merging
1320
73
from a branch you created, you merge from the branch that the contributor asks
1321
74
you to.
1322
75
1323
76
    $ bzr merge-package lp:~barry/ubuntu/natty/foobar/bug-12345
1324
77
1325
78
The difference would be that if there are lots of merge conflicts then you
1326
79
would probably want to ask the contributor to fix them up.  To do that see the
1327
80
next section.
1328
81
1329
82
Cancelling an upload
1330
83
====================
1331
84
1332
85
At any time before you `dput` the source package you can decide to cancel an
1333
86
upload.
1334
87
1335
88
    $ bzr revert
1336
89
1337
90
You can do this if you notice something needs more work, or if you would like
1338
91
to ask the contributor to fix up conflicts when sponsoring something.
1339
92
1340
93
1341
94
Sponsoring something and making your own changes
1342
95
================================================
1343
96
1344
97
If you are going to sponsor someone's work, but you would like to roll it up
1345
98
with some changes of your own then you can merge their work in to a separate
1346
99
branch first.
1347
100
1348
101
If you already have a branch where you are working on the package and you
1349
102
would like to include their changes, then simply run the `bzr merge-package`
1350
103
from that branch, instead of the checkout of the development package.  You can
1351
104
then make the changes and commit, and then carry on with your changes to the
1352
105
package.
1353
106
1354
107
If you don't have an existing branch, but you know you would like to make
1355
108
changes based on what the contributor provides then you should start by
1356
109
grabbing their branch.
1357
110
1358
111
    $ bzr branch lp:~barry/ubuntu/natty/foobar/bug-12345
1359
112
1360
113
then work in this new branch, and then merge it in to the main one and upload
1361
114
as if it was your own work.  The contributor will still be mentioned in the
1362
115
changelog, and bzr will correctly attribute the changes they made to them.
1363
116
1364
117
.. _`Personal Package Archive`: https://help.launchpad.net/Packaging/PPA
1365
0
118
1366
=== added file 'docs/working.rst'
1367
--- docs/working.rst	1970-01-01 00:00:00 +0000
1368
+++ docs/working.rst	2011-01-11 23:17:27 +0000
1369
@@ -0,0 +1,59 @@
1370
1
====================
1371
2
Working on a Package
1372
3
====================
1373
4
1374
5
Once you have the package source you may wish to do more with it than just
1375
6
examine the source and the history.
1376
7
1377
8
1378
9
Branching for a change
1379
10
======================
1380
11
1381
12
In order to work on a change to the package you should create a branch
1382
13
in which you work. You base this branch off the branch for the release
1383
14
that you plan to upload to, usually the development release.
1384
15
1385
16
First check that you have latest code.  Let's say I've already branched the
1386
17
`foobar` package from the latest Ubuntu development release, and I want to
1387
18
create a branch to fix bug 12345.  I am in the shared repository directory
1388
19
that I created earlier for `foobar`::
1389
20
1390
21
    $ bzr branch natty bug-12345
1391
22
    $ cd bug-12345
1392
23
1393
24
Now you can do all my work in the `bug-12345` directory.  You make changes
1394
25
there as necessary, committing as you go along.  This is just like doing any
1395
26
kind of software development with Bazaar.  You can make intermediate commits
1396
27
as often as you like, and when your changes are finished, you will use the
1397
28
standard `dch` command (from the `devscripts` package)::
1398
29
1399
30
    $ dch -i
1400
31
1401
32
This will drop you in an editor to add the `debian/changelog` entry.  When you
1402
33
commit this change, the log message will be copied from that entry::
1403
34
1404
35
    $ bzr commit
1405
36
1406
37
1407
38
Building the package
1408
39
====================
1409
40
1410
41
In order to build the package you can use the `bzr builddeb` command from
1411
42
the `bzr-builddeb` package.  You can build a source package with::
1412
43
1413
44
    $ bzr bd -S
1414
45
1415
46
(`bd` is an alias for `builddeb`.)  You can leave the package unsigned by
1416
47
appending `-- -uc -us` to the command.
1417
48
1418
49
It is also possible to use your normal tools, as long as they are able to
1419
50
strip the .bzr directories from the package, e.g.::
1420
51
1421
52
    $ debuild -i -I
1422
53
1423
54
If you ever see an error related to trying to build a native package without a
1424
55
tarball, check to see if there is a `.bzr-builddeb/default.conf` file
1425
56
erroneously specifying the package as native.  If the changelog version has a
1426
57
dash in it, then it's not a native package, so remove the configuration file.
1427
58
Note that while `bzr bd` has a `--native` switch, it does not have a
1428
59
`--no-native` switch.
Reviewer	Review Type	Date Requested	Status
John A Meinel		2011-01-11	Approve on 2011-01-28
Review via email: mp+45932@code.launchpad.net