[Pkg-bazaar-commits] r189 ./bzr-builddeb/people/jdw/dev: Add more help for the bd-do command.

[James Westby]

------------------------------------------------------------
revno: 189
committer: James Westby <jw+debian at jameswestby.net>
branch nick: dev
timestamp: Sun 2007-09-16 17:59:59 +0100
message:
  Add more help for the bd-do command.
modified:
  __init__.py
  doc/user_manual/merge.rst
-------------- next part --------------
=== modified file '__init__.py'
--- a/__init__.py	2007-09-16 16:24:23 +0000
+++ b/__init__.py	2007-09-16 16:59:59 +0000
@@ -467,6 +467,22 @@
   operations difficult. This command allows you to run any command in an
   exported source directory, copying the resulting debian/ directory back
   to your branch if the command is successful.
+
+  For instance:
+
+    bzr bd-do
+
+  will run a shell in the unpacked source. Any changes you make in the
+  ``debian/`` directory will be copied back to the branch. If you exit with
+  a non-zero exit code (e.g. "exit 1"), then the changes will not be copied
+  back.
+
+  You can also specify single commands to be run, e.g.
+
+    bzr bd-do "dpatch-edit-patch 01-fix-build"
+
+  Note that only the first argument is used as the command, and so the above
+  example had to be quoted.
   """
 
   takes_args = ['command?']

=== modified file 'doc/user_manual/merge.rst'
--- a/doc/user_manual/merge.rst	2007-09-15 22:11:56 +0000
+++ b/doc/user_manual/merge.rst	2007-09-16 16:59:59 +0000
@@ -130,5 +130,25 @@
 nothing is done. If files are added or removed by the command that you run
 then you will have to ``bzr add`` or ``bzr rm`` them as necessary.
 
+For instance you can run::
+
+  bzr bd-do
+
+and have a shell in the unpacked source directory. You can then run any
+commands that you would like. If you then exit the shell normally the contents
+of ``debian/`` will be copied back, and be present in your branch. If you exit
+with a non-zero exit code, for instance by running ``exit 1`` then you will
+abort any changes, and they will not show up in your branch.
+
+You can also run any command by passing it as the first argument to the
+``bd-do`` command. For instance if you use ``dpatch`` in your package the
+following may be useful::
+
+  bzr bd-do "dpatch-edit-patch 01-fix-build"
+
+Note that only the first argument is used, so the command had to be quoted.
+The command is run through the shell, so you can execute multiple commands
+in one step by separating them with ``&&`` or ``;``.
+
 .. vim: set ft=rst tw=76 :