Rev 5307: Clarify documentation about pqm usage. in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Fri Jun 18 12:57:16 BST 2010
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 5307 [merge]
revision-id: pqm at pqm.ubuntu.com-20100618115713-5d0yqkzo14eu94t4
parent: pqm at pqm.ubuntu.com-20100618104031-m2fg5gtcy2o47ghh
parent: mbp at canonical.com-20100611074409-6q0n1niwmt6c297s
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Fri 2010-06-18 12:57:13 +0100
message:
Clarify documentation about pqm usage.
modified:
NEWS NEWS-20050323055033-4e00b5db738777ff
doc/developers/HACKING.txt HACKING-20050805200004-2a5dc975d870f78c
doc/developers/contribution-quickstart.txt contributionquicksta-20091118014608-u0t1h53l2t81rir3-1
=== modified file 'NEWS'
--- a/NEWS 2010-06-18 10:40:31 +0000
+++ b/NEWS 2010-06-18 11:57:13 +0000
@@ -107,6 +107,9 @@
ready-to-go for the next action (including other people doing
development). (Robert Collins)
+* Remove obsolete discussion of PQM in documentation about how to
+ contribute to Bazaar. (Martin Pool, #588444)
+
API Changes
***********
=== modified file 'doc/developers/HACKING.txt'
--- a/doc/developers/HACKING.txt 2010-06-02 05:03:31 +0000
+++ b/doc/developers/HACKING.txt 2010-06-11 07:44:09 +0000
@@ -885,157 +885,6 @@
how to set it up and configure it.
-Submitting Changes
-==================
-
-An Overview of PQM
-------------------
-
-Of the many workflows supported by Bazaar, the one adopted for Bazaar
-development itself is known as "Decentralized with automatic gatekeeper".
-To repeat the explanation of this given on
-http://wiki.bazaar.canonical.com/Workflows:
-
-.. pull-quote::
- In this workflow, each developer has their own branch or
- branches, plus read-only access to the mainline. A software gatekeeper
- (e.g. PQM) has commit rights to the main branch. When a developer wants
- their work merged, they request the gatekeeper to merge it. The gatekeeper
- does a merge, a compile, and runs the test suite. If the code passes, it
- is merged into the mainline.
-
-In a nutshell, here's the overall submission process:
-
-#. get your work ready (including review except for trivial changes)
-#. push to a public location
-#. ask PQM to merge from that location
-
-.. note::
- At present, PQM always takes the changes to merge from a branch
- at a URL that can be read by it. For Bazaar, that means a public,
- typically http, URL.
-
-As a result, the following things are needed to use PQM for submissions:
-
-#. A publicly available web server
-#. Your OpenPGP key registered with PQM (contact RobertCollins for this)
-#. The PQM plugin installed and configured (not strictly required but
- highly recommended).
-
-
-Selecting a Public Branch Location
-----------------------------------
-
-If you don't have your own web server running, branches can always be
-pushed to Launchpad. Here's the process for doing that:
-
-Depending on your location throughout the world and the size of your
-repository though, it is often quicker to use an alternative public
-location to Launchpad, particularly if you can set up your own repo and
-push into that. By using an existing repo, push only needs to send the
-changes, instead of the complete repository every time. Note that it is
-easy to register branches in other locations with Launchpad so no benefits
-are lost by going this way.
-
-.. note::
- For Canonical staff, http://people.ubuntu.com/~<user>/ is one
- suggestion for public http branches. Contact your manager for information
- on accessing this system if required.
-
-It should also be noted that best practice in this area is subject to
-change as things evolve. For example, once the Bazaar smart server on
-Launchpad supports server-side branching, the performance situation will
-be very different to what it is now (Jun 2007).
-
-
-Configuring the PQM Plug-In
----------------------------
-
-While not strictly required, the PQM plugin automates a few things and
-reduces the chance of error. Before looking at the plugin, it helps to
-understand a little more how PQM operates. Basically, PQM requires an
-email indicating what you want it to do. The email typically looks like
-this::
-
- star-merge source-branch target-branch
-
-For example::
-
- star-merge http://bzr.arbash-meinel.com/branches/bzr/jam-integration http://bazaar-vcs.org/bzr/bzr.dev
-
-Note that the command needs to be on one line. The subject of the email
-will be used for the commit message. The email also needs to be ``gpg``
-signed with a key that PQM accepts.
-
-The advantages of using the PQM plugin are:
-
-#. You can use the config policies to make it easy to set up public
- branches, so you don't have to ever type the full paths you want to merge
- from or into.
-
-#. It checks to make sure the public branch last revision matches the
- local last revision so you are submitting what you think you are.
-
-#. It uses the same public_branch and smtp sending settings as bzr-email,
- so if you have one set up, you have the other mostly set up.
-
-#. Thunderbird refuses to not wrap lines, and request lines are usually
- pretty long (you have 2 long URLs in there).
-
-Here are sample configuration settings for the PQM plugin. Here are the
-lines in bazaar.conf::
-
- [DEFAULT]
- email = Joe Smith <joe.smith at internode.on.net>
- smtp_server=mail.internode.on.net:25
-
-And here are the lines in ``locations.conf`` (or ``branch.conf`` for
-dirstate-tags branches)::
-
- [/home/joe/bzr/my-integration]
- push_location = sftp://joe-smith@bazaar.launchpad.net/%7Ejoe-smith/bzr/my-integration/
- push_location:policy = norecurse
- public_branch = http://bazaar.launchpad.net/~joe-smith/bzr/my-integration/
- public_branch:policy = appendpath
- pqm_email = Bazaar PQM <pqm at bazaar-vcs.org>
- pqm_branch = http://bazaar-vcs.org/bzr/bzr.dev
-
-Note that the push settings will be added by the first ``push`` on
-a branch. Indeed the preferred way to generate the lines above is to use
-``push`` with an argument, then copy-and-paste the other lines into
-the relevant file.
-
-
-Submitting a Change
--------------------
-
-Here is one possible recipe once the above environment is set up:
-
-#. pull bzr.dev => my-integration
-#. merge patch => my-integration
-#. fix up any final merge conflicts (NEWS being the big killer here).
-#. commit
-#. push
-#. pqm-submit
-
-.. note::
- The ``push`` step is not required if ``my-integration`` is a checkout of
- a public branch.
-
- Because of defaults, you can type a single message into commit and
- pqm-commit will reuse that.
-
-
-Tracking Change Acceptance
---------------------------
-
-The web interface to PQM is https://pqm.bazaar-vcs.org/. After submitting
-a change, you can visit this URL to confirm it was received and placed in
-PQM's queue.
-
-When PQM completes processing a change, an email is sent to you with the
-results.
-
Planning Releases
=================
=== modified file 'doc/developers/contribution-quickstart.txt'
--- a/doc/developers/contribution-quickstart.txt 2010-02-23 02:32:52 +0000
+++ b/doc/developers/contribution-quickstart.txt 2010-06-11 07:44:09 +0000
@@ -65,6 +65,16 @@
with your local and Launchpad usernames inserted.
+
+Publishing your changes
+-----------------------
+
+After you've locally committed your changes, the configuration above
+should be enough that you can push them to Launchpad with a simple ::
+
+ $ bzr push
+
+
Writing tests
-------------
More information about the bazaar-commits
mailing list