[Pkg-bazaar-commits] ./bzr-builddeb/trunk r237: Add documentation on building remote branches.

[James Westby]

------------------------------------------------------------
revno: 237
committer: James Westby <jw+debian at jameswestby.net>
branch nick: trunk
timestamp: Fri 2008-05-30 00:01:55 +0100
message:
  Add documentation on building remote branches.
  
  The documentation warns the user about the strange directories that
  may be used.
modified:
  doc/user_manual/building.rst
  doc/user_manual/hooks.rst
-------------- next part --------------
=== modified file 'doc/user_manual/building.rst'
--- a/doc/user_manual/building.rst	2007-10-23 21:25:20 +0000
+++ b/doc/user_manual/building.rst	2008-05-29 23:01:55 +0000
@@ -72,5 +72,28 @@
 
 lists them all.
 
+Remote Branches
+---------------
+
+It is possible to build directly from remote branches, e.g.::
+
+  $ bzr builddeb http://bzr.debian.org/pkg-bazaar/bzr-builddeb/trunk/
+
+This doesn't require you to have any of the branch history locally, and will
+just download what is needed to build the branch.
+
+Note however that it may create the files in a suprising location. It will still
+default to ``../build-area/`` and will in fact use the
+``.bzr-builddeb/default.conf`` file from the remote branch, which may alter this.
+
+To avoid this you may want to override these things on the command line,
+e.g.::
+
+  $ bzr builddeb --build-dir=. --orig-dir=. \
+        http://bzr.debian.org/pkg-bazaar/bzr-builddeb/trunk/
+
+which will use the current directory as a working area, and leave the resulting
+packages in the current directory.
+
 .. vim: set ft=rst tw=76 :
 

=== modified file 'doc/user_manual/hooks.rst'
--- a/doc/user_manual/hooks.rst	2007-09-16 19:40:35 +0000
+++ b/doc/user_manual/hooks.rst	2008-05-29 23:01:55 +0000
@@ -49,6 +49,8 @@
 run all necessary commands from the default hooks that are necessary to build
 the package.
 
+.. _configuration: configuration.html
+
 The hooks are set in a ``[HOOKS]`` section of the configuration file. The
 key is the hook point that the hook is set for, the value is the command(s)
 to run. For instance to run autoconf before building you would set the