Merge lp:~jelmer/bzr-builddeb/dep3-patch-help into lp:bzr-builddeb

[Jelmer Vernooij]

Extend the description of 'bzr dep3-patch'.

[James Westby (james-w)]

Hi,

Thanks for doing this.

I think an example of usage could be helpful, as understanding what will
be included is perhaps a little tricky.

Thanks,

James

review: Approve

=== modified file 'cmds.py'
--- cmds.py	2012-03-03 06:05:49 +0000
+++ cmds.py	2012-03-07 00:06:21 +0000
@@ -1429,6 +1429,17 @@
 class cmd_dep3_patch(Command):
     """Format the changes in a branch as a DEP-3 patch.
 
+    This will generate a patch file containing as much information
+    specified by DEP-3 (http://dep.debian.net/deps/dep3/) as possible.
+
+    The patch will contain all changes that are not merged into
+    the current branch (either that in the current working directory
+    or specified by --directory) but are present and committed
+    in the branch at the specified location.
+
+    To generate the "Status" header, this command will check the
+    upstream branch to verify if the change has made it upstream,
+    unless --no-upstream-check was specified.
     """
 
     takes_args = ["location?"]