[Pkg-bazaar-maint] Bug#551981: bzr-builddeb: --result option is documented as --result-dir

[Andrea Bolognani]

Package: bzr-builddeb
Version: 0.95
Severity: minor
Tags: patch

Hi,

the documentation obtained using `bzr help builddeb' contains the
following text:

	$ bzr help builddeb
	[...]
	for use in merge mode, defaults to ../tarballs. --result-dir specifies where
	the resulting package files should be placed, defaults to whatever is 
	used for the build directory. --result-dir will have problems if you use a
	build command that places the results in a different directory.
	[...]

However,

	$  bzr builddeb --orig-dir ../../../tarballs/ \
	> --result-dir ../../../build-area/
	bzr: ERROR: no such option: --result-dir
	$

while

	$  bzr builddeb --orig-dir ../../../tarballs/ \
	> --result ../../../build-area/
	[builds just fine]
	$

The attached patch (modify_documentation.diff) fixes the problem by syncing
the inline documentation with the actual option name. It's a simple
two-line patch which doesn't touch the code, so no harm can possibly be
done by applying it.

However, since having that option named --result instead of --result-dir is
not coherent with the other options (--orig-dir and --build-dir), I've made
a second patch (modify_behavior.diff), which changes the code to reflect the
documentation.

This is not a simple name change, since I've modified the behavior as well,
to make it orthogonal with the behavior of the other two options. I feel
pretty confident the patch is harmless, but I can offer no guarantee.

By the way, I feel a --dir-prefix or similar option would be nice to have,
so that you will be able to replace

	$ bzr builddeb --orig-dir ../../../tarballs \
	  --build-dir ../../../build-area \
	  --result-dir ../../../build-area

with just

	$ bzr builddeb --dir-prefix ../../../

to save some typing when you're building from a branch deep into a shared
repository. But I'll file a separate, wishlist bug about that another day.

Cheers.

-- System Information:
Debian Release: squeeze/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'unstable'), (1, 'experimental')
Architecture: i386 (i686)

Kernel: Linux 2.6.30-2-686 (SMP w/1 CPU core)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages bzr-builddeb depends on:
ii  bzr                           2.0.1-1    easy to use distributed version co
ii  bzrtools                      2.0.1-1    Collection of tools for bzr
ii  devscripts                    2.10.55    scripts to make the life of a Debi
ii  dpkg-dev                      1.15.3.1   Debian package development tools
ii  fakeroot                      1.14       Gives a fake root environment
ii  patchutils                    0.3.1-2    Utilities to work with patches
ii  python                        2.5.4-2    An interactive high-level object-o
ii  python-apt                    0.7.13.3   Python interface to libapt-pkg
ii  python-central                0.6.11     register and build utility for Pyt
ii  python-debian                 0.1.14     Python modules to work with Debian

bzr-builddeb recommends no packages.

Versions of packages bzr-builddeb suggests:
pn  bzr-svn                       <none>     (no description available)

-- no debconf information
-------------- next part --------------
A non-text attachment was scrubbed...
Name: modify_documentation.diff
Type: text/x-diff
Size: 967 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/pkg-bazaar-maint/attachments/20091022/de43db7d/attachment-0002.diff>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: modify_behavior.diff
Type: text/x-diff
Size: 3434 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/pkg-bazaar-maint/attachments/20091022/de43db7d/attachment-0003.diff>