425422: clarify pdebuild.1 documentation

3 files changed, 27 insertions, 18 deletions

diff --git a/ChangeLog b/ChangeLog
index 2f1d002..e47d75d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2007-05-27  Junichi Uekawa  <dancer@debian.org>
 
+	* pdebuild.1: fix from 
+
 	* Documentation/pbuilder-doc.xml: add documentation about
 	C11screen.
 
diff --git a/debian/changelog b/debian/changelog
index 3532747..4b48a39 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -14,6 +14,8 @@ pbuilder (0.167) UNRELEASED; urgency=low
   - output is tee'd to terminal and also the logfile.
   * add C11screen example script, which starts up GNU screen after build
     failure.
+  * pdebuild.1 documentation clarification, thanks to Sanjoy Mahajan
+    (Closes: #425422).
 
   * shut up lintian: specify debian/compat (4) instead of DH_COMPAT in debian/rules
   * shut up lintian about binnmuability. Use {source:Version} instead of
@@ -24,7 +26,7 @@ pbuilder (0.167) UNRELEASED; urgency=low
     dependencies in experimental, to support unsigned APT repositories, and to
     not install Recommends.
 
- -- Junichi Uekawa <dancer@debian.org>  Sun, 27 May 2007 14:52:51 +0900
+ -- Junichi Uekawa <dancer@debian.org>  Sun, 27 May 2007 15:41:12 +0900
 
 pbuilder (0.166) unstable; urgency=low
 
diff --git a/pdebuild.1 b/pdebuild.1
index 872c1cf..a8eadff 100644
--- a/pdebuild.1
+++ b/pdebuild.1
@@ -11,7 +11,7 @@ which invokes pbuilder after obtaining appropriate root privilege
 in a Debian source directory.
 One must be inside the source tree containing the
 .B "debian"
-directory, in order to make it work.
+directory.
 
 By default, build log file is stored in
 ../<package>_<version>_<arch>.build.
@@ -22,9 +22,9 @@ By default, build log file is stored in
 The first option is always the operation to be done.
 It is followed by options of the form
 .BI "\-\-" "option name"
-which will modify the semantics as explained below.
-They are applied from left-to-right, and when there are 
-conflicting options, the rightmost options will have effect.
+which modify the semantics as explained below.
+They are applied from left to right, and when
+options conflict, the rightmost options take effect.
 
 .TP
 .BI "\-\-buildsourceroot [" "fakeroot" "]"
@@ -49,18 +49,18 @@ Invoke debsign at the end of pdebuild process.
 .BI "\-\-debsign\-k [" "key\-id" "]"
 Pass 
 .B \-k
-option to debsign to specify which key-id to sign.
+option to debsign to specify which key-id to sign with.
 
 .TP
 .BI "\-\-buildresult [" "Directory for build results" "]"
 
-The place which build result is stored.
+The place where the build result is stored.
 
-Note that for pdebuild, buildresult needs to be specified as pdebuild
-option in the command-line, not as pbuilder option.
+Note that for pdebuild, buildresult needs to be specified as a pdebuild
+option on the command-line, not as a pbuilder option.
 
 Note that the default value for buildresult is what is defined for
-pbuilder,
+pbuilder, which is
 .B "/var/cache/pbuilder/result"
 and not 
 .B ".."
@@ -80,6 +80,9 @@ This option overrides pbuilder option
 
 Multiple options are delimited with spaces.
 
+Note that for pdebuild, debbuildopts needs to be specified as a pdebuild
+option in the command-line, not as a pbuilder option.
+
 .TP
 .BI "\-\-use\-pdebuild\-internal"
 Uses a different implementation of pdebuild, which calls clean and build inside 
@@ -87,7 +90,7 @@ the chroot, using bind-mounts.
 
 .B "pdebuild\-internal"
 tries to run debian/rules clean inside the chroot.
-To achieve the goal, the working directory is passed on inside the chroot,
+To do so, the working directory is passed on inside the chroot,
 in the form of bind-mounting and
 .B debuild 
 is run.
@@ -116,14 +119,16 @@ Show a brief help message.
 After the 
 .B "\-\-"
 symbol, an arbitrary number of pbuilder options can be specified.
-See pbuilder.8 for full list of options.
+See pbuilder.8 for a full list of options.
 
 
 There is an exception that
 .B "\-\-buildresult"
-needs to be specified as pdebuild option before the 
+and
+.B "\-\-debbuildopts"
+need to be specified as pdebuild options before the 
 .B "\-\-"
-to be effective.
+in order to be effective.
 
 .SH "FILES"
 .TP
@@ -136,8 +141,8 @@ The default configuration file for pbuilder, used in pdebuild.
 
 .TP
 .I "${HOME}/.pbuilderrc"
-Configuration file for pbuilder, used in pdebuild,
-overrides what is written in
+Configuration file for pbuilder, used in pdebuild.  It
+overrides
 .B /etc/pbuilderrc
 
 
@@ -181,10 +186,10 @@ option.  However, unless the option is documented in the manual page,
 it may be ignored.
 
 .SH "AUTHOR"
-Initial coding, and main maintenance is done by 
+Initial coding and main maintenance is done by 
 Junichi Uekawa <dancer@debian.org>.
 
-The homepage is available at
+The homepage is
 .B "\%http://www.netfort.gr.jp/~dancer/software/pbuilder.html"
 
 .SH "SEE ALSO"