Bug#783135: sbuild: Description of --dist in manpage is incomplete

[Johannes Schauer]

Control: tags -1 + patch

Hi,

On Wed, 22 Apr 2015 12:13:37 -0700 Dima Kogan  wrote:
> Hi. In the sbuild manpage, the only thing stated about --dist is
> 
>-d, --dist=distribution
>   Fetch source packages from specified distribution.
> 
> This description implies that this setting only controls where sources
> come from, which isn't the case. In particular, --dist sets the
> OVERRIDE_DISTRIBUTION setting (set_options() in Options.pm), and this
> setting affects what ends up in the .changes file (build() in Build.pm).
> I think the manpage description should say this.

indeed! Thanks for bringing this up. The --dist option has so many side effects
that there definitely needs more explaining to be done.

I have attached patch in my local git and will soon push it to the remote if
there are no further remarks.

Thanks!

cheers, josch
From 8b9c2e45edc6ed08ea9a748a7dcc6b0ef6e1899c Mon Sep 17 00:00:00 2001
From: Johannes 'josch' Schauer 
Date: Thu, 1 Oct 2015 07:37:59 +0200
Subject: [PATCH] man/sbuild.1.in: update docs for --dist option (Closes:
 #783135)

---
 man/sbuild.1.in | 6 +-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/man/sbuild.1.in b/man/sbuild.1.in
index 6696636..6454dfb 100644
--- a/man/sbuild.1.in
+++ b/man/sbuild.1.in
@@ -202,7 +202,11 @@ Use the specified chroot. If not specified, the default is the first of
 \fI$distribution\-$arch\fP or \fI$distribution\fP that exists.
 .TP
 .BR \-d ", " "\-\-dist=\fIdistribution\fP"
-Fetch source packages from specified distribution.
+Explicitly set the distribution for the package build. This will be selecting
+the correct chroot to use and also sets the value of the Distribution field in
+the created .changes file. Setting this option is necessary when giving sbuild
+a .dsc file or a plain source package name to build. In the latter case it
+specifies the distribution the source package is fetched from.
 .TP
 .BR \-\-archive=\fIarchive\fP
 Communicate with specified archive.
-- 
2.5.1



signature.asc
Description: signature

Bug#783135: sbuild: Description of --dist in manpage is incomplete

[Dima Kogan]

Package: sbuild
Version: 0.65.2-1dima3
Severity: normal

Hi. In the sbuild manpage, the only thing stated about --dist is

   -d, --dist=distribution
  Fetch source packages from specified distribution.

This description implies that this setting only controls where sources
come from, which isn't the case. In particular, --dist sets the
OVERRIDE_DISTRIBUTION setting (set_options() in Options.pm), and this
setting affects what ends up in the .changes file (build() in Build.pm).
I think the manpage description should say this.

Thanks!


-- System Information:
Debian Release: 8.0
  APT prefers unstable
  APT policy: (800, 'unstable'), (700, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Foreign Architectures: armhf, armel, i386

Kernel: Linux 3.16-3-amd64 (SMP w/2 CPU cores)
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968) (ignored: LC_ALL set to C)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages sbuild depends on:
ii  adduser 3.113+nmu3
ii  apt-utils   1.0.9.5
ii  libsbuild-perl  0.65.2-1dima3
ii  perl5.20.1-4

Versions of packages sbuild recommends:
ii  debootstrap  1.0.67
ii  fakeroot 1.20.2-1

Versions of packages sbuild suggests:
pn  deborphan  none
ii  wget   1.16-3

-- Configuration Files:
/etc/sbuild/sbuild.conf changed:
1;


-- no debconf information


-- 
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org