Merge lp:~barry/udd/docs into lp:udd

[Barry Warsaw]

This converts the wiki documentation to a reStructuredText document. I got tired of editing the wiki. I have not yet added /usr/share/doc/bzr-builddeb/user_manual but I intend to do that once this branch lands and is published.

I'm not positive this is the best place for this, but I couldn't think of anything better. Also, we'll need a web server some place to throw this onto.

[John A Meinel (jameinel)]

Sorry for not reviewing this earlier. I think there is something wrong which is causing us to not see the review request. Maybe the default reviewer is set to something we don't see?

I didn't actually review the content, since I'm pretty sure what you wanted was just to have this included as rest docs.

I'm wondering if this is the best branch to have the documentation in. I suppose it is *a* branch which deals with this code. I might have said "udd-docs" or some other project, but in the short term, this seems fine. I'd rather have it available somewhere than nowhere.

Then we just need to figure out how to get this deployed so people can actually browse it.

Is it as simple as running "make" on Jubany and having the output in the right place for "package-import.ubuntu.com" to show it?

review: Approve

[Barry Warsaw (barry)]

On Jan 28, 2011, at 04:06 PM, John A Meinel wrote:

>I didn't actually review the content, since I'm pretty sure what you wanted
>was just to have this included as rest docs.

Yep. I want to get the documentation out of the wiki.

>I'm wondering if this is the best branch to have the documentation in. I
>suppose it is *a* branch which deals with this code. I might have said
>"udd-docs" or some other project, but in the short term, this seems fine. I'd
>rather have it available somewhere than nowhere.

I agree that this is not the best place for the docs. Since submitting this
mp, I've chatted with Daniel and I actually think it's better in the new
packaging guide he's putting together. I plan on moving the docs over to that
project (thankfully, also in reST :).

>Then we just need to figure out how to get this deployed so people can
>actually browse it.

I'm pretty sure Daniel is working on that for the packaging guide, so we
should get that for free once it's integrated there.

>Is it as simple as running "make" on Jubany and having the output in the
>right place for "package-import.ubuntu.com" to show it?

I have no idea! ;)

[Max Bowsher (maxb)]

Hi Barry,

Based on your earlier comment in this MP and recent email on the u-d-d mailing list, is it correct that these docs are now targeted at landing in lp:ubuntu-packaging-guide ?

If so, would it be accurate to mark this MP as superseded so that it no longer shows up on udd's +activereviews page?

Thanks,
Max.

[Barry Warsaw (barry)]

Hi Max. Yep, you're correct, and in fact they *have* landed in upg, so I'll close this merge proposal.

[Barry Warsaw (barry)]

Well, it doesn't look like I can. I can only set the mp status to WiP, Needs review, or Merged. I have abandoned the branch and invalid'd the bug, but I'll leave it up to you to dispose of this mp.

Unmerged revisions

389. By Barry Warsaw on 2011-01-11

new packages

388. By Barry Warsaw on 2011-01-11

Added patchsys

387. By Barry Warsaw on 2011-01-11

More wiki conversion

386. By Barry Warsaw on 2011-01-11

Latest

385. By Barry Warsaw on 2011-01-11

uploading.rst

384. By Barry Warsaw on 2011-01-11

More page conversions.

383. By Barry Warsaw on 2011-01-11

Convert getting.

382. By Barry Warsaw on 2011-01-11

Twiddle.

381. By Barry Warsaw on 2011-01-11

sphinx-quickstart

380. By Barry Warsaw on 2011-01-11

The start of some documentation.

=== modified file '.bzrignore'
--- .bzrignore	2010-02-18 20:26:19 +0000
+++ .bzrignore	2011-01-11 23:17:27 +0000
@@ -1,1 +1,2 @@
 ./tags
+_build

=== added directory 'docs'
=== added file 'docs/Makefile'
--- docs/Makefile	1970-01-01 00:00:00 +0000
+++ docs/Makefile	2011-01-11 23:17:27 +0000
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/udd.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/udd.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/udd"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/udd"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

=== added directory 'docs/_static'
=== added directory 'docs/_templates'
=== added file 'docs/conf.py'
--- docs/conf.py	1970-01-01 00:00:00 +0000
+++ docs/conf.py	2011-01-11 23:17:27 +0000
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# udd documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 11 13:19:17 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'udd'
+copyright = u'2011, Barry Warsaw'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'udddoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'udd.tex', u'udd Documentation',
+   u'Barry Warsaw', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'udd', u'udd Documentation',
+     [u'Barry Warsaw'], 1)
+]

=== added file 'docs/getting.rst'
--- docs/getting.rst	1970-01-01 00:00:00 +0000
+++ docs/getting.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,102 @@
+==================
+Getting the source
+==================
+
+Every source package in Ubuntu has an associated source branch on Launchpad.
+These source branches are updated automatically by Launchpad, however if you
+notice any version skew (e.g. version 1.7 is available as a source package but
+only 1.5 as a source branch), see the `importer status page`_ for possible
+failures.
+
+If your source package is not yet available in Ubuntu, but it is available in
+Debian, see below for importing the Debian source package into a local Bazaar
+branch.
+
+Either way, if you want to work on a source package in bzr then you should
+create a shared repository on your machine in order to make future operations
+more efficient. Once you have that then you can checkout branches in to it.
+
+There are a couple of things that we do first in order to make things more
+efficient later. Once you are used to the process you will learn when it makes
+sense to skip these steps.
+
+
+Creating a shared repository
+============================
+
+Say we want to work on the `foobar` source package.  We first create a shared
+repository to hold our branches for this package.
+
+We do this using the `bzr init-repo` command, passing it the directory name we
+would like to use::
+
+    $ bzr init-repo foobar
+
+You will see that a `foobar` directory is created in your current working
+area.  Now we need to change to this new directory for the rest of our work::
+
+    $ cd foobar
+
+
+Getting the trunk branch
+========================
+
+We use the `bzr branch` command to create a local branch of the package, and
+the `ubuntu:` directory service (URL prefix) so that we can specify a shorter
+URL::
+
+    $ bzr branch ubuntu:foobar
+
+You will need at least bzr 2.3 to utilize the `ubuntu:` prefix, otherwise
+you'll use the `lp:` prefix for slightly longer URLs::
+
+    $ bzr branch lp:ubuntu/foobar
+
+This will create a branch in the new `foobar` directory.  It will contain the
+contents of the source package for the current Ubuntu development release
+(also called a *distroseries*).  If you prefer to name the resulting directory
+after the current distroseries, do something like::
+
+    $ bzr branch ubuntu:foobar natty
+
+This puts the branch for the `foobar` package in Natty_ into the `natty`
+directory.
+
+
+Getting a branch for a particular release
+=========================================
+
+When you want to do something like a `stable release update`_ (SRU), or you
+just want to examine the code in an old release, you may want to grab the
+branch corresponding to a particular pocket in a particular Ubuntu release.
+All package versions in all distroseries are exposed on Launchpad and
+available through both the `ubuntu:` and `lp:` directory services.  For
+example, to get the `foobar` package for Maverick *one* of the following:
+
+    $ bzr branch ubuntu:m/foobar maverick
+    $ bzr branch ubuntu:maverick/foobar maverick
+    $ bzr branch lp:ubuntu/maverick/foobar maverick
+
+
+Importing a Debian source package
+=================================
+
+If the package you want to work on is available in Debian but not Ubuntu, it's
+still easy to import the code to a local bzr branch for development.  Let's
+say you want to import the `newpackage` source package.  We'll start by
+creating a shared repository as normal, but we also have to create a working
+tree to which the source package will be imported::
+
+    $ bzr init-repo newpackage
+    $ cd new-package
+    $ bzr init debian
+    $ cd debian
+    $ bzr import-dsc http://ftp.de.debian.org/debian/pool/main/n/newpackage/newpackage_1.0-1.dsc
+
+As you can see, we just need to provide the remote location of the dsc file,
+and bzr will do the rest.  You've now got a bzr source branch.
+
+.. _`importer status page`: http://package-import.ubuntu.com/status
+.. _Natty: https://wiki.ubuntu.com/NattyNarwhal
+.. _`stable release update`: https://wiki.ubuntu.com/StableReleaseUpdates
+.. _Maverick: https://wiki.ubuntu.com/MaverickMeerkat

=== added file 'docs/index.rst'
--- docs/index.rst	1970-01-01 00:00:00 +0000
+++ docs/index.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,59 @@
+==============================
+Ubuntu Distributed Development
+==============================
+
+*Ubuntu Distributed Development* (UDD) is a technique for developing Ubuntu
+ packages that uses tools, processes, and workflows similar to generic
+ distributed version control system-based software development.  The dVCS used
+ for UDD is Bazaar_.
+
+UDD is an ongoing effort.  This means that some things will not yet be
+documented, and some things that are documented will not yet work.  Volunteers
+to help move this forward are of course, welcome.
+
+This document contains a series of task-oriented guides for helping you with
+common tasks.  Intrepid_ or later is currently required for these instructions
+to work.
+
+
+Related information
+===================
+
+The UDD project has a `presence on the Ubuntu wiki`_ which contains a
+(probably out-of-sync) copy of this documentation, links to the bug tracker
+and `project page on Launchpad`_, as well as links and minutes of public
+meetings.
+
+Once the relevant packages are installed, you might also find useful
+information in `/usr/share/doc/bzr-builddeb/usr_manual/`.
+
+
+Table of Contents
+=================
+
+.. toctree::
+    :glob:
+
+    setup
+    getting
+    working
+    sponsorship
+    uploading
+    latest
+    merging
+    patchsys
+    newpackage
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+.. _`Bazaar`: http://bazaar.canonical.com/en/
+.. _`Intrepid`: https://wiki.ubuntu.com/IntrepidIbex
+.. _`presence on the Ubuntu wiki`: https://wiki.ubuntu.com/DistributedDevelopment
+.. _`project page on Launchpad`: http://launchpad.net/udd

=== added file 'docs/latest.rst'
--- docs/latest.rst	1970-01-01 00:00:00 +0000
+++ docs/latest.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,46 @@
+==================
+Getting The Latest
+==================
+
+If someone else has landed changes on a package, you will want to pull down
+those changes in your own copies of the package branches.
+
+
+Updating your main branch
+=========================
+
+Updating your copy of a branch that corresponds to the package in a particular
+release is very simple, simply use `bzr pull` from the appropriate directory::
+
+    $ cd foobar/natty
+    $ bzr pull
+
+This works wherever you have a checkout of a branch, so it will work for
+things like branches of `maverick`, `hardy-proposed`, etc.
+
+
+Getting the latest in to your working branches
+==============================================
+
+Once you have updated your copy of a distroseries branch, then you may want to
+merge this in to your working branches as well, so that they are based on the
+latest code.
+
+You don't have to do this all the time though.  You can work on slightly older
+code with no problems.  The disadvantage would come if you were working on
+some code that someone else changed.  If you are not working on the latest
+version then your changes may not be correct, and may even produce conflicts.
+
+The merge does have to be done at some point though.  The longer it is left,
+the harder may be, so doing it regularly should keep each merge simple.  Even
+if there are many merges the total effort would hopefully be less.
+
+To merge the changes you just need to use `bzr merge-package`, but you must
+have committed your current work first.
+
+    $ cd foobar/bug-12345
+    $ bzr merge-package ../natty
+
+Any conflicts will be reported, and you can fix them up.  To review the
+changes that you just merged use `bzr diff`.  To undo the merge use `bzr
+revert`.  Once you are happy with the changes then use `bzr commit`.

=== added file 'docs/merging.rst'
--- docs/merging.rst	1970-01-01 00:00:00 +0000
+++ docs/merging.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,113 @@
+=======
+Merging
+=======
+
+Merging is one of the strengths of Bazaar, and something we do often in Ubuntu
+development.  Updates can be merged from Debian, from a new upstream release,
+and from other Ubuntu developers.
+
+Doing it in bzr is pretty simple, and all based around the `bzr merge-package`
+command.
+
+The first thing to do is to check that the `package importer`_ hasn't failed
+for the package you're going to work on.
+
+When you are in any branch's working directory then you can merge from
+another.  First check you have no uncommitted changes::
+
+    $ bzr status
+
+If that reports anything then you will either have to commit the changes,
+revert them, or shelve them to come back to later.
+
+
+Merging from Debian
+===================
+
+Next run `bzr merge-package` passing the URI of the branch to merge from.  For
+instance, to merge from the version of the package in Debian Squeeze_ run::
+
+    $ bzr merge-package lp:debian/squeeze/foobar
+
+This will merge the changes since the last merge point and leave you with
+changes to review.  This may cause some conflicts.  You can see all that
+happened by running::
+
+    $ bzr status
+    $ bzr diff
+
+If conflicts are reported then you need to edit those files to make them look
+how they should, removing the *conflict markers*.  Once you have done, run::
+
+    $ bzr resolve
+    $ bzr conflicts
+
+This will resolve any conflicted files that you fixed, and then tell you what
+else you have to deal with.
+
+Once any conflicts are resolved, and you have made any other changes that you
+need, you will add a new changelog entry, and commit::
+
+    $ dch -i
+    $ bzr commit
+
+as described earlier.
+
+However, before you commit, it is always a good thing to check all the Ubuntu
+changes by running::
+
+    $ bzr diff -r tag:0.6.10-5
+
+which will show the diff between the new Debian (0.6.10-5) and Ubuntu versions
+(0.6.10-5ubuntu1).  In similar way you can compare to any other versions.  To
+see all available version run::
+
+    $ bzr tags
+
+After testing and committing the merge, you will need to seek sponsorship or
+upload to the archive in the normal way.
+
+
+Merging a new upstream version
+==============================
+
+When upstream releases a new version (or you want to package a snapshot) then
+you have to merge a tarball into your branch.
+
+This is done using the `bzr merge-upstream` command.  From inside the branch
+that you want to merge to you run something like::
+
+    $ bzr merge-upstream --version 1.2 http://example.org/releases/foobar-1.2.tar.gz
+
+This will download that tarball and merge it in to your branch, automatically
+adding a `debian/changelog` entry for you.
+
+The `--version` option is used to specify the upstream version that is being
+merged in, as the command isn't able to infer that yet.
+
+The last parameter is the location of the tarball that you are upgrading to;
+this can either be a local filesystem path, or a http, ftp, sftp, etc. URI as
+shown.  The command will automatically download the tarball for you.  If you
+point to a `.tar.bz2` or similar tarball then it will recompress it as needed,
+or convert it if you pass it a `.zip` or similar.  If your package is v3
+(quilt) format and so can support `.tar.bz2` upstream tarballs then pass a
+`--v3` option to prevent the repacking (this should be `automatically
+detected`_).
+
+The `merge-upstream` command will either tell you that it completed
+successfully, or that there were conflicts.  Either way you will be able to
+review the changes before committing as normal.
+
+If you are merging an upstream release into an existing bzr branch that has
+not previously used the UDD layout, `bzr merge-upstream` will fail with an
+error that the tag for the previous upstream version is not available; the
+merge can't be completed without knowing what base version to merge against.
+To work around this, create a tag in your existing existing repo for the last
+upstream version present there; e.g., if the last Ubuntu release was
+*1.1-0ubuntu3*, create the tag *upstream-1.1* pointing to the bzr revision you
+want to use as the tip of the upstream branch.
+
+
+.. _`package importer`:  http://package-import.ubuntu.com/status/
+.. _Squeeze: http://wiki.debian.org/DebianSqueeze
+.. _`automatically detected`: https://bugs.edge.launchpad.net/bzr-builddeb/+bug/627718

=== added file 'docs/newpackage.rst'
--- docs/newpackage.rst	1970-01-01 00:00:00 +0000
+++ docs/newpackage.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,171 @@
+======================
+Building a new package
+======================
+
+Let's say I have an upstream project that is not yet available for Ubuntu.  I
+want to create a package from this project and make it available as a PPA_ so
+that other people can more easily use the code.  This also makes a good first
+step in contributing your package to universe_.
+
+
+Example package
+===============
+
+I started with a Python library called `flufl.enum`_, which is a fairly
+typical setuptools-based Python package.  Fortunately, it's also maintained in
+Launchpad using Bazaar, so that makes bootstrapping much easier.  (TBD: add
+instructions for using other upstream VCSs.)
+
+Because we want to package the trunk branch, getting started is pretty
+simple::
+
+    $ bzr init-repo flufl.enum
+    $ cd flufl.enum
+    $ bzr branch lp:flufl.enum trunk
+    $ bzr branch trunk debianize
+    $ cd debianize
+
+
+Bootstrapping
+=============
+
+You need to get the initial ``debian`` directory created somehow, along with
+all the expected files inside that.  There are many ways to bootstrap that,
+and hopefully there will eventually be `some convergence`_ in the methods,
+especially if you're building standard Python setuptools-based libraries and
+applications.
+
+
+The bzr-builddeb way
+--------------------
+
+You could of course just use `dh_make(8)` to get things going, or you could
+use `bzr dh-make`.  The latter might provide some benefits, and can be run
+like so from inside your branch::
+
+    $ bzr dh-make PKGNAME VERSION DOWNLOADURL
+    $ bzr add debian
+
+If you don't have a URL to download a tarball from, you'll need to create the
+tarball locally first.  Use ``bzr dh-make --help`` for details on this command.
+
+After you've created the ``debian`` directory template, be sure to ``bzr rm``
+any ``debian`` files you don't need (e.g. the ``*.ex`` files), and edit files
+such as ``debian/control``, ``debian/watch``, ``debian/copyright`` and
+``debian/changelog``.  The following section may give you some hints about
+that.
+
+
+The stdeb way
+-------------
+
+Another way I've found useful for initializing the ``debian`` directory for
+Python setuptools-based packages, is to use the stdeb_ package.  The full
+documentation for this package is available on the `upstream home`_, but you
+won't need all of the commands.  stdeb has a command that is *exactly* what
+we're looking for!
+
+In either case, start by putting this in your ``~/.pydistutils.cfg`` file::
+
+    [global]
+    command.packages:stdeb.command
+
+
+Modern stdeb
+~~~~~~~~~~~~
+
+Here's how easy it is::
+
+    $ python setup.py debianize
+    $ bzr add debian
+    $ bzr commit -m'Debianize'
+
+
+We also need a ``debian/copyright`` file.  Normally, we'd use ``dh_make -c``
+for that but again, that doesn't play nicely with UDD.  ``dh_make`` expects a
+particular file system layout that we don't have.  No matter, we'll add the
+copyright file manually::
+
+    $ cp /usr/share/debhelper/dh_make/licenses/lgpl3 debian/copyright
+    $ edit debian/copyright
+    $ bzr add debian/copyright
+    $ bzr commit -m'Added copyright file'
+
+
+stdeb <= 0.5.1
+~~~~~~~~~~~~~~
+
+If you have an older version of stdeb, use this command to create the basic
+``debian/`` directory layout::
+
+    $ python setup.py sdist_dsc
+
+This command leaves you with a ``deb_dist`` directory containing a
+``flufl.enum_3.0.1`` directory.  Inside that is your ``debian/`` directory.
+Because we're using UDD we don't care about anything else that ``sdist_dsc``
+produces, so we can shuffle things around and remove the cruft.
+
+    $ mv deb_dist/munepy-2.0.1/debian .
+    $ rm -rf deb_dist
+    $ bzr add debian
+    $ bzr commit -m'Add debian directory'
+
+
+pkgme
+-----
+
+pkgme_ is a new tool that makes it easy to Debianize a new package.  TBD:
+describe how to use it.
+
+
+debian/control file
+===================
+
+You probably want to edit the ``debian/control`` file at this point, adding
+any information that's missing, or fixing incorrect default information.  For
+example, I needed to modify the ``Maintainer`` and ``Description`` fields, and
+add ``XS-Python-Version`` and ``Homepage`` fields.
+
+Now we want to build the source package.  The easiest way to do that is with
+the ``bzr-builddeb`` plugin, however this requires a valid ``debian/watch``
+file so that builddeb can find the upstream tarball.  This really should match
+the version of the checkout you've made.
+
+
+debian/watch file
+=================
+
+Here for example is the ``debian/watch`` file I'm using::
+
+    version=3
+    http://pypi.python.org/packages/source/f/flufl.enum/flufl.enum-(.*).tar.gz
+
+If your tarballs live on Launchpad, the ``debian/watch`` file is a little more
+complicated (see `Question 21146`_ and `Bug 231797`_ for why this is).  In
+that case, use something like::
+
+    version=3
+    https://launchpad.net/flufl.enum/+download http://launchpad.net/flufl.enum/.*/flufl.enum-(.+).tar.gz
+
+So, then it's a matter of...::
+
+    $ bzr add debian/watch
+    $ bzr commit -m'added debian/watch file'
+
+
+Building the source package
+===========================
+
+Now we can build the source package and publish the package as we normally
+would, with ``bzr bd -S`` and ``dput``.
+
+
+.. _PPA: https://help.launchpad.net/Packaging/PPA
+.. _universe: https://wiki.ubuntu.com/MOTU/GettingStarted
+.. _`flufl.enum`: http://launchpad.net/flufl.enum
+.. _`some convergence`: http://launchpad.net/bugs/545361
+.. _stdeb: http://packages.ubuntu.com/lucid/python-stdeb
+.. _`upstream home`: http://github.com/astraw/stdeb#the-commands
+.. _pkgme: https://launchpad.net/pkgme
+.. _`Question 21146`: https://answers.launchpad.net/launchpad/+question/21146
+.. _`Bug 231797`: https://launchpad.net/bugs/231797

=== added file 'docs/patchsys.rst'
--- docs/patchsys.rst	1970-01-01 00:00:00 +0000
+++ docs/patchsys.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,188 @@
+===========================
+Working with a patch system
+===========================
+
+Many existing packages that have changes from upstream express those changes
+using a `patch system`_, of which there are several to choose from.  Usually,
+when you make an additional change to a package, you'll want to add a patch
+file to the patch system being used, rather than editing the source code in
+place.  Note however that it is considered bad practice to add a patch system
+to a package that does not already have one.  In that case, either coordinate
+with the Debian maintainer, or edit the files in place.  You can find out if
+your package has a patch system by using the ``what-patch`` command (from the
+``ubuntu-dev-tools`` package).
+
+Although UDD, and in particular `Bazaar looms`_ makes it pretty easy to keep
+individual patches separated, if you're submitting changes to be uploaded,
+you're currently better off playing along with the package's patch system.
+*You will want at least bzr loom version 2.2.1dev, otherwise you'll have
+problems pushing and pulling your threads to Launchpad.* Do ``bzr plugins`` to
+find the version you're using.
+
+Here are some guidelines that I've found helpful.  Clearly the existing tools
+can be improved, but for now this seems to work well enough.  This assumes
+you're using looms to develop your patch, and that the package itself uses the
+quilt_ patch system.
+
+One important thing to know: all source branches reflect the tree after a
+``quilt push -a``.  In other words, when you branch a source branch, you get
+the tree with all patches applied, ready for you to jump right into hacking.
+You do not need to ``quilt push -a`` manually, and in fact, you'll get a tree
+with lots of distracting modifications if you push or pop all the changes.  Or
+to put it another way, once you have a branch, jump right in!
+
+
+Develop your patch
+==================
+
+Start as you normally would with UDD and looms::
+
+    $ bzr init-repo foobar
+    $ cd foobar
+    $ bzr branch ubuntu:foobar (or lp:ubuntu/foobar)
+    $ bzr branch foobar myfix
+    $ cd myfix
+    $ bzr loomify --base trunk
+    $ bzr create-thread sourcefix
+
+Now that you are in the ``sourcefix`` thread, just edit the source code,
+making whatever changes you need to fix the bug.  Don't worry about the patch
+system at this point, at least until you are happy with your changes.  If
+someone else pushes changes to the package while you're working on it, just
+``bzr down-thread`` to ``trunk``, pull the updates, and ``bzr up-thread
+--auto`` back to the ``sourcefix`` thread, resolving any conflicts along the
+way.  You can periodically commit your changes, ``bzr record`` and push them
+to Launchpad as you go, of course linking your branch to the bug in Launchpad.
+So far, it's just normal development with looms.
+
+Once you're happy with your changes, you need to essentially import your
+thread's changes into a quilt patch.  This is fairly easy to do::
+
+    $ bzr create-thread quiltfix
+    $ bzr diff -rthread:trunk..thread:sourcefix | quilt import -p0 -P myfix /dev/stdin
+    $ bzr add debian/patches/myfix
+    $ quilt push
+    $ quilt pop
+    $ bzr commit
+
+Why the last push/pop before the commit?  The push gets the imported changes
+into the quilt patch, but also leaves the tree modified, so you'll essentially
+have the changes both in the ``debian/`` directory and in the tree.  The pop
+undoes the tree changes (which are also available in the ``sourcefix``
+thread), but leaves the quilt change available.  A ``bzr commit`` at this
+point gives you a thread with just the changes to ``debian/``.
+
+
+Problems
+========
+
+The problem comes when you want to modify the patch, e.g.::
+
+    $ bzr down-thread
+    <hack, commit>
+
+This does *not* work well::
+
+    $ bzr up-thread
+
+You'd expect at this point to be able to ``quilt fold`` your new changes to
+update your ``myfix`` quilt patch, but in fact, this doesn't work.  You can
+end up with difficult to resolve conflicts, patch failures and rejections.  My
+recommendation is that when you make changes to your ``sourcefix`` thread,
+blow away your ``quiltfix`` thread and regenerate it.  Looms make this easy::
+
+    $ bzr up-thread
+    $ bzr revert
+    $ bzr combine-thread --force (throws away your quiltfix changes)
+    $ bzr create-thread quiltfix
+    $ bzr diff -rthread:trunk..thread:sourcefix | quilt import -p0 -P myfix /dev/stdin
+    etc...
+
+So you've thrown away the ``quiltfix`` thread, and recreated it, with your
+updated ``sourcefix`` changes.
+
+
+Gotchas
+=======
+
+One thing to keep in mind is that quilt uses a hidden ``.pc`` directory to
+record its status.  This directory is under version control in all source
+branches.  *Watch out* for changes to the ``.pc`` directory that are unrelated
+(or more accurately, uninteresting) to your patch.  This can happen because
+the UDD source branch importer `currently includes any existing .pc
+directory`_ in the imported branch.  This can cause conflicts, or other
+unwanted or unknown changes because you've essentially got two conflicting
+version control systems competing for the same thing (i.e. bzr and quilt3).
+For now, the best recommendation is to revert any changes to the ``.pc``
+directory in your branch.
+
+
+Publishing your changes
+=======================
+
+It's actually easier at this point to generate a diff for attaching to the bug
+report.  Just::
+
+    $ bzr up-thread -auto
+    $ bzr diff -rthread: > mypatch.diff
+
+The differences between the ``quiltfix`` thread and the ``sourcefix`` thread
+are the interesting bits, and totally appropriate for committing and upload.
+Because of the way looms interacts with Launchpad, you can still link your
+branch to the bug and request a merge proposal, but understand that the diff
+will include all changes between ``quiltfix`` (top) and ``trunk`` (bottom)
+threads.  So the merge proposal will include the changes in the ``debian/``
+directory, *and* the changes in the source tree.  As long as you and your
+reviewer understands this, you should be okay, but it can be confusing at
+first.
+
+If you need a sponsor to merge and upload your changes, one thing they *do
+not* want to do is::
+
+    $ bzr branch ubuntu:foobar
+    $ cd foobar
+    $ bzr merge lp:~you/ubuntu/natty/foobar/yourfix
+
+Much badness (in the form of infinite *maximum recursion depth* exceptions)
+ensues.  Yes, we need to file a bug on that.
+
+
+edit-patch
+==========
+
+``edit-patch`` is a nice little wrapper script that comes as part of the
+``ubuntu-dev-tools`` package.  It pretty much hides the nasty details of
+dealing with the patch system specifically.  For example, while the above
+works well if your package is using quilt already, you'll have to adjust the
+workflow, perhaps significantly, to work with `a different patch system`_.  In
+theory ``edit-patch`` should solve this, but there are currently two blockers.
+
+  * By default, ``bzr diff`` produces a ``-p0`` patch, but ``edit-patch``
+    defers to the underlying patch system's default.  For quilt, this is
+    ``-p1``.  ``quilt import`` takes a ``-p`` argument to specify the prefix
+    level, but this isn't yet exposed in ``edit-patch``.  If you're
+    adventurous, try changing the ``bzr diff`` command above to specify the
+    proper prefixes using its ``-p`` option.
+  * By default, ``edit-patch`` requires a path to an existing patch file, but
+    it's more convenient to pipe the output of ``bzr diff`` to the stdin of
+    ``edit-patch``, as shown above.  The alternative would be to save the diff
+    in a temporary file, and then point ``edit-patch`` to this temporary file.
+
+
+Future
+======
+
+Ideally, it would be nice to add a ``bzr edit-patch`` or some such command
+which does the whole loom -> patch system import.  At least ``edit-patch``
+could grow a ``-p`` and ``-P`` option, as well as read from stdin.  Stay
+tuned, or get involved!
+
+There's now `a bug` that tracks this.
+
+
+.. _`patch system`: https://wiki.ubuntu.com/DistributedDevelopment/Documentation/PatchSystem/PackagingGuide/PatchSystems
+.. _`Bazaar looms`: https://launchpad.net/bzr-loom
+.. _quilt: http://www.wzdftpd.net/blog/index.php?2008/02/05/3-quilt-a-patch-management-system-how-to-survive-with-many-patches
+.. _`currently includes any existing .pc directory`: https://bugs.launchpad.net/udd/+bug/672740
+.. _`a different patch system`: http://wiki.debian.org/debian/patches
+.. _`a bug`: https://launchpad.net/bugs/620721

=== added file 'docs/setup.rst'
--- docs/setup.rst	1970-01-01 00:00:00 +0000
+++ docs/setup.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,48 @@
+==========
+Setting up
+==========
+
+
+Installing Packages
+===================
+
+You will first need to install packages to make the tools available to you.
+The packages you need to install are `bzr` and `bzr-builddeb`::
+
+    $ sudo aptitude install bzr bzr-builddeb
+
+
+Introducing yourself to bzr
+===========================
+
+In order to properly attribute your work to you bzr needs to know your name
+and email address, which you can specify with the `bzr whoami` command::
+
+    $ bzr whoami "James Westby <[e-mail]>"
+
+You don't have to give your real name, and you don't have to give your
+email address, but doing so is a good idea for Ubuntu development.
+
+
+Telling bzr about your launchpad account
+========================================
+
+bzr can work better with Launchpad_ if you tell it what your Launchpad
+username is with the `bzr launchpad-login` command::
+
+    $ bzr launchpad-login james-w
+
+where you should substitute your own Launchpad id for `james-w`.  If you don't
+have a Launchpad account you can easily `create one`_.  If you don't know your
+Launchpad id, you can find out what this is by going to
+https://launchpad.net/people/+me and looking at the part after `~` in the URL.
+
+The `launchpad-login` command will fail if you haven't set up an SSH key in
+Launchpad yet, but it is `easy to do that`_.
+
+Now you are ready to use bzr to do Ubuntu development.
+
+
+.. _Launchpad: http://launchpad.net
+.. _`create one`: https://launchpad.net/+login
+.. _`easy to do that`: https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair

=== added file 'docs/sponsorship.rst'
--- docs/sponsorship.rst	1970-01-01 00:00:00 +0000
+++ docs/sponsorship.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,110 @@
+===================
+Seeking Sponsorship
+===================
+
+If you have made a change to the package and you do not have rights to upload
+the package then you will need to seek a sponsor.
+
+Note that many sponsorships are still done via debdiffs, and some sponsors
+will prefer that, so you may wish to attach a diff to the bug as well.
+
+
+Linking to bugs
+===============
+
+You will need a bug report to seek sponsorship, and you should refer to this
+issue from your `debian/changelog`.  Fill in the changelog entry by running
+`dch -i` and add the `LP: #12345` entry as normal.  For example::
+
+    foobar (1.0-2ubuntu1) natty; urgency=low
+
+      * debian/control: Fixed a crash in the baz submodule  (LP: #12345)
+
+     -- Barry Warsaw <[e-mail]>  Mon, 04 Jan 2010 15:33:52 -0500
+
+The format of the bug reference must match exactly; if you leave out the space
+or the `#` then the issue will not be closed correctly once your change
+lands.  You may also want to use the `--fixes` option on the `bzr commit`
+command to link your branch to the bug report::
+
+    $ bzr commit --fixes lp:12345
+
+Now, when you push the branch to Launchpad it will link the branch to the bug
+report.
+
+It is not critical to have a link to a bug for every change you make,
+but if you are fixing reported bugs then linking to them will be useful.
+
+
+Pushing to Launchpad
+====================
+
+Now you should push the branch to Launchpad so that it can be retrieved
+by others. You do this by pushing it to a branch under your user id::
+
+    $ bzr push lp:~james-w/ubuntu/natty/foobar/bug-12345
+
+where you substitute your Launchpad user id for *james-w*, and the Ubuntu
+release code name you're targeting for *natty*.  If you linked a commit to a
+bug number as shown above, then the Launchpad page for the bug will include a
+link to your branch.
+
+However, this usually isn't enough to get Ubuntu developers to review your
+change.  You should next submit a *merge proposal* so that the developers can
+find your fix and review it.
+
+To do this open your page in a browser, e.g.
+
+    $ bzr lp-open
+
+if that fails, then you can use
+
+    $ xdg-open https://code.launchpad.net/~james-w/ubuntu/natty/foobar/bug-12345
+
+where most of the URL matches what you used for `bzr push`.  On this page,
+you'll see a link that says *Propose for merging into another branch*.  Type
+in an explanation of your change in the *Initial Comment* box.  Lastly, click
+*Propose Merge* to complete the process.
+
+Merge proposals to package source branches will automatically subscribe the
+`~ubuntu-branches` team, which should be enough to reach an Ubuntu developer
+who can review and sponsor your package change.
+
+
+Generating a debdiff
+====================
+
+As noted above, many sponsors still prefer reviewing a *debdiff* attached to
+bug reports instead of a merge proposal.  If you're requested to include a
+debdiff, you can generate one like this (from inside your `bug-12345`
+branch)::
+
+    $ bzr diff -rbranch:../natty
+
+Another way is to is to open the merge proposal and download the diff.
+
+You should ensure that diff has the changes you expect, no more and no less.
+Name the diff appropriately e.g. foobar-12345.debdiff and attach it to the bug
+report.
+
+
+Dealing with feedback from sponsors
+===================================
+
+If a sponsor reviews your change and asks you to change something then you can
+do this fairly easily.  Simply go to the branch that you were working in
+before and make the changes requested, and then commit::
+
+    $ bzr commit
+
+Now you can push your changes up to Launchpad as before, but bzr will have
+remembered where you pushed to, so you can simply run::
+
+    $ bzr push
+
+You can then reply to the request for changes explaining what you changed, and
+asking for re-review, or you can reply on the merge proposal page in
+Launchpad.
+
+Note if you are sponsored via debdiff attached to a bug report you need to
+manually update it as described above.

=== added file 'docs/uploading.rst'
--- docs/uploading.rst	1970-01-01 00:00:00 +0000
+++ docs/uploading.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,117 @@
+===================
+Uploading a package
+===================
+
+Once your merge proposal is reviewed and approved, you will want to upload
+your package, either to the archive (if you have permission) or to your
+*Personal Package Archive* (PPA).  You might also want to do an upload if you
+are sponsoring someone else's changes.
+
+
+Uploading a change made by you
+==============================
+
+When you have a branch with a change that you would like to upload you need to
+get that change back on to the main branch and then upload it.
+
+First, you need to check that you have the latest version of the package in
+your checkout of the development package::
+
+    $ cd foobar/natty
+    $ bzr pull
+
+If this pulls in any changes that may have been committed while you were
+working on your fix.  From here, you have several options.  If the changes on
+the trunk are large, and it will take a while to merge them and test the
+package, then you can merge them back in to your work branch to do this.  If
+not, then you can carry on merging your work branch in to the main one::
+
+    $ bzr merge-package ../bug-12345
+
+This will merge the two trees, possibly producing conflicts, which you'll need
+to resolve manually.
+
+Next you should make sure the `debian/changelog` is as you would like, with
+the correct distribution, version number, etc.
+
+Once that is done you should review the change you are about to commit
+with `bzr diff`.  This should show you the same changes as a debdiff would
+before you upload the source package.
+
+The next step is to build and test the modified source package as you normally
+would.  Once you are happy with the upload then you should `dput` the
+source package.  For example, if you want to upload your changes to your PPA,
+then you'd do::
+
+    $ dput ppa:me/myppa foobar_1.0-2ubuntu1.dsc
+
+You might want to do one more `bzr commit` to make sure all your changes are
+committed in your working tree.
+
+The last step is to mark the change as being the same as the source package
+that was uploaded, so run::
+
+    $ bzr mark-uploaded
+
+This also tells the package importer that what is in bzr is the same as in the
+archive.
+
+Now you can push the changes back to Launchpad::
+
+    $ bzr push ubuntu:foobar
+
+(Change the destination if you are uploading an SRU or similar.)
+
+You are now free to delete your feature branch, as it is merged, and can
+be recovered if needed.
+
+
+Sponsoring a change
+===================
+
+Sponsoring a change is just like the above procedure, but instead of merging
+from a branch you created, you merge from the branch that the contributor asks
+you to.
+
+    $ bzr merge-package lp:~barry/ubuntu/natty/foobar/bug-12345
+
+The difference would be that if there are lots of merge conflicts then you
+would probably want to ask the contributor to fix them up.  To do that see the
+next section.
+
+Cancelling an upload
+====================
+
+At any time before you `dput` the source package you can decide to cancel an
+upload.
+
+    $ bzr revert
+
+You can do this if you notice something needs more work, or if you would like
+to ask the contributor to fix up conflicts when sponsoring something.
+
+
+Sponsoring something and making your own changes
+================================================
+
+If you are going to sponsor someone's work, but you would like to roll it up
+with some changes of your own then you can merge their work in to a separate
+branch first.
+
+If you already have a branch where you are working on the package and you
+would like to include their changes, then simply run the `bzr merge-package`
+from that branch, instead of the checkout of the development package.  You can
+then make the changes and commit, and then carry on with your changes to the
+package.
+
+If you don't have an existing branch, but you know you would like to make
+changes based on what the contributor provides then you should start by
+grabbing their branch.
+
+    $ bzr branch lp:~barry/ubuntu/natty/foobar/bug-12345
+
+then work in this new branch, and then merge it in to the main one and upload
+as if it was your own work.  The contributor will still be mentioned in the
+changelog, and bzr will correctly attribute the changes they made to them.
+
+.. _`Personal Package Archive`: https://help.launchpad.net/Packaging/PPA

=== added file 'docs/working.rst'
--- docs/working.rst	1970-01-01 00:00:00 +0000
+++ docs/working.rst	2011-01-11 23:17:27 +0000
@@ -0,0 +1,59 @@
+====================
+Working on a Package
+====================
+
+Once you have the package source you may wish to do more with it than just
+examine the source and the history.
+
+
+Branching for a change
+======================
+
+In order to work on a change to the package you should create a branch
+in which you work. You base this branch off the branch for the release
+that you plan to upload to, usually the development release.
+
+First check that you have latest code.  Let's say I've already branched the
+`foobar` package from the latest Ubuntu development release, and I want to
+create a branch to fix bug 12345.  I am in the shared repository directory
+that I created earlier for `foobar`::
+
+    $ bzr branch natty bug-12345
+    $ cd bug-12345
+
+Now you can do all my work in the `bug-12345` directory.  You make changes
+there as necessary, committing as you go along.  This is just like doing any
+kind of software development with Bazaar.  You can make intermediate commits
+as often as you like, and when your changes are finished, you will use the
+standard `dch` command (from the `devscripts` package)::
+
+    $ dch -i
+
+This will drop you in an editor to add the `debian/changelog` entry.  When you
+commit this change, the log message will be copied from that entry::
+
+    $ bzr commit
+
+
+Building the package
+====================
+
+In order to build the package you can use the `bzr builddeb` command from
+the `bzr-builddeb` package.  You can build a source package with::
+
+    $ bzr bd -S
+
+(`bd` is an alias for `builddeb`.)  You can leave the package unsigned by
+appending `-- -uc -us` to the command.
+
+It is also possible to use your normal tools, as long as they are able to
+strip the .bzr directories from the package, e.g.::
+
+    $ debuild -i -I
+
+If you ever see an error related to trying to build a native package without a
+tarball, check to see if there is a `.bzr-builddeb/default.conf` file
+erroneously specifying the package as native.  If the changelog version has a
+dash in it, then it's not a native package, so remove the configuration file.
+Note that while `bzr bd` has a `--native` switch, it does not have a
+`--no-native` switch.