Merge lp:~andrewsomething/ubuntu-dev-tools/man-pages into lp:~ubuntu-dev/ubuntu-dev-tools/trunk

[Andrew Starr-Bochicchio]

  * syncpackage: Update manpage to reflect current usage. (LP: #598477)
  * ubuntu-build: Update manpage to reflect current usage. (LP: #490535)
  * edit-patch: Add manpage. (LP: #538379)
  * massfile: Add manpage.
  * pull-debian-debdiff: Add manpage.
  * setup-packaging-environment: Add manpage.
  * ubuntu-iso: Add manpage.

[Benjamin Drung (bdrung)]

There are lintian informational warnings:

I: ubuntu-dev-tools: hyphen-used-as-minus-sign usr/share/man/man1/massfile.1.gz:25
I: ubuntu-dev-tools: hyphen-used-as-minus-sign usr/share/man/man1/massfile.1.gz:26
I: ubuntu-dev-tools: hyphen-used-as-minus-sign usr/share/man/man1/massfile.1.gz:27

The syncpackage man page should be updated to state that syncpackage will detect mismatching source tarballs and will create automatically fake syncs instead. syncpackage is _the_ tool for fake syncs.

review: Needs Fixing

[lp:~andrewsomething/ubuntu-dev-tools/man-pages]

669. By Andrew Starr-Bochicchio on 2010-06-29

massfile: Remember to escape minus signs in man page.

670. By Andrew Starr-Bochicchio on 2010-06-29

syncpackage: Update man page to mention that it does fakesyncs.

671. By Andrew Starr-Bochicchio on 2010-06-29

massfile: One more minus sign to escape in man page.

[Andrew Starr-Bochicchio (andrewsomething)]

Thanks Benjamin. I just pushed fixes for these issues.

=== modified file 'debian/changelog'
--- debian/changelog	2010-06-27 15:13:15 +0000
+++ debian/changelog	2010-06-29 14:24:29 +0000
@@ -1,3 +1,4 @@
+<<<<<<< TREE
 ubuntu-dev-tools (0.101) UNRELEASED; urgency=low
 
   * doc/syncpackage.1:
@@ -5,6 +6,20 @@
 
  -- Luca Falavigna <[e-mail]>  Sun, 27 Jun 2010 17:12:03 +0200
 
+=======
+ubuntu-dev-tools (0.101) UNRELEASED; urgency=low
+
+  * syncpackage: Update manpage to reflect current usage. (LP: #598477)
+  * ubuntu-build: Update manpage to reflect current usage. (LP: #490535)
+  * edit-patch: Add manpage. (LP: #538379)
+  * massfile: Add manpage.
+  * pull-debian-debdiff: Add manpage.
+  * setup-packaging-environment: Add manpage.
+  * ubuntu-iso: Add manpage.
+
+ -- Andrew Starr-Bochicchio <[e-mail]>  Sat, 26 Jun 2010 14:40:48 -0400
+
+>>>>>>> MERGE-SOURCE
 ubuntu-dev-tools (0.100) maverick; urgency=low
 
   [ Luca Falavigna ]

=== added file 'doc/edit-patch.1'
--- doc/edit-patch.1	1970-01-01 00:00:00 +0000
+++ doc/edit-patch.1	2010-06-29 14:24:29 +0000
@@ -0,0 +1,22 @@
+.TH EDIT-PATCH "1" "June 2010" "ubuntu-dev-tools"
+.SH NAME
+\fBedit-patch\fR \- tool for preparing patches for Debian source packages
+
+.SH SYNOPSIS
+\fBedit-patch\fR <path to patch>
+
+.SH DESCRIPTION
+\fBedit-patch\fR is a wrapper script around the quilt, cdbs, and dpatch patch systems. It simplifies the process of preparing and editing patches to Debian source packages and allows the user to not have to be concerned with which patch system is in use. Run from inside the root directory of the source package, \fBedit-patch\fR can be used to edit existing patches located in /debian/patches.
+
+It can also be used to incorporate new patches. If pointed a patch not already present, it will copy the patch to /debian/patches in the correct format for the patch system in use. Next, the patch is applied and a subshell is opened in order to edit the patch. Typing "exit" or hitting Ctrl-d will close the subshell and launch an an editor to record the debian/changelong entry.
+
+\fBedit-patch\fR is integrated with the bzr and git version control systems. The patch will be automatically added to the tree, and the debian/changelong entry will be used as the commit message.
+
+If no patch system is present, the patch is applied inline, and a copy is stored in debian/patches-applied. 
+
+.SH AUTHORS
+\fBedit-patch\fR was written by Daniel Holbach <[e-mail]>, Michael Vogt <[e-mail]>, and David Futcher <[e-mail]>.
+
+This manual page was written by Andrew Starr-Bochicchio <[e-mail]>.
+.PP
+Both are released under the terms of the GNU General Public License, version 3.

=== added file 'doc/massfile.1'
--- doc/massfile.1	1970-01-01 00:00:00 +0000
+++ doc/massfile.1	2010-06-29 14:24:29 +0000
@@ -0,0 +1,45 @@
+.TH MASSFILE "1" "June 2010" "ubuntu-dev-tools"
+.SH NAME
+\fBmassfile\fR \- script for massfiling bugs against Ubuntu packages
+
+.SH SYNOPSIS
+\fBmassfile\fR <path to instructions file> <path to list file>
+
+.SH DESCRIPTION
+\fBmassfile\fR is a script for massfiling bugs against Ubuntu packages in Launchpad. It requires an instructions file describing the contents of the bug report and a list file which lists the packages which the bug will be filed against.
+
+Templates for both files can be found in /usr/share/doc/ubuntu-dev-tools/examples.
+
+.SH EXAMPLES
+\fBmassfile.instructions\fR - file designating the contents of the bug report
+
+ subject: [UNMETDEPS] $pack has unmet dependencies
+ assignee: 
+ status: confirmed
+ subscribers: motu
+ tags: unmetdeps
+ buglist-url: http://bugs.launchpad.net/ubuntu/+bugs?field.tag=unmetdeps
+ text:
+  A run of 
+  .
+   LC_ALL=C apt-cache \-i unmet | grep ^Package | cut \-d' ' \-f2 | grep
+   \-v dbgsym | sort \-u | xargs apt-cache showsrc | grep ^Directory |
+   sed 's/Package\:\ //g' | grep verse | cut \-d'/' \-f4
+  indicates that the source package $pack has binary packages that are
+  not installable (on AMD64) at the moment.
+  .
+  Please have a look and make sure it's installable again.
+
+\fBmassfile.list\fR - file designating the packages affected
+
+Each package should be listed on a new line as follows:
+
+ z88dk
+ zope-quotafolder
+
+.SH AUTHORS
+\fBmassfile\fR was written by Iain Lane <[e-mail]>, Daniel Hahler <[e-mail]>. and Markus Korn <[e-mail]>.
+
+This manual page was written by Andrew Starr-Bochicchio <[e-mail]>.
+.PP
+Both are released under the terms of the GNU General Public License, version 3.

=== added file 'doc/pull-debian-debdiff.1'
--- doc/pull-debian-debdiff.1	1970-01-01 00:00:00 +0000
+++ doc/pull-debian-debdiff.1	2010-06-29 14:24:29 +0000
@@ -0,0 +1,16 @@
+.TH PULL-DEBIAN-DEBDIFF "1" "June 2010" "ubuntu-dev-tools"
+.SH NAME
+\fBpull-debian-debdiff\fR \- find, download, and generate a debdiff
+
+.SH SYNOPSIS
+\fBpull-debian-debdiff\fR <package> <version>
+
+.SH DESCRIPTION
+\fBpull-debian-debdiff\fR attempts to find and download a specific version of a Debian package and its immediate parent to generate a debdiff.
+
+.SH AUTHORS
+\fBpull-debian-debdiff\fR was written by Kees Cook <[e-mail]>.
+
+This manual page was written by Andrew Starr-Bochicchio <[e-mail]>.
+.PP
+Both are released under the terms of the GNU General Public License, version 3, or (at your option) any later version.

=== added file 'doc/setup-packaging-environment.1'
--- doc/setup-packaging-environment.1	1970-01-01 00:00:00 +0000
+++ doc/setup-packaging-environment.1	2010-06-29 14:24:29 +0000
@@ -0,0 +1,16 @@
+.TH PULL-DEBIAN-DEBDIFF "1" "June 2010" "ubuntu-dev-tools"
+.SH NAME
+\fBsetup-packaging-environment\fR \- helps to get started with Ubuntu development
+
+.SH SYNOPSIS
+\fBsetup-packaging-environment\fR
+
+.SH DESCRIPTION
+\fBsetup-packaging-environment\fR aims to make it more straightforward for new contributors to get their Ubuntu installation ready for packaging work. It ensures that all four components from Ubuntu's official repositories are enabled along with their corresponding source repositories. It also installs a minimal set of packages needed for Ubuntu packaging work (ubuntu-dev-tools, devscripts, debhelper, cdbs, patchutils, pbuilder, and build-essential). Finally, it assists in defining the DEBEMAIL and DEBFULLNAME environment variables.
+
+.SH AUTHORS
+\fBsetup-packaging-environment\fR was written by Siegfried-A. Gevatter <[e-mail]>.
+
+This manual page was written by Andrew Starr-Bochicchio <[e-mail]>.
+.PP
+Both are released under the terms of the GNU General Public License, version 3 or later.

=== modified file 'doc/syncpackage.1'
--- doc/syncpackage.1	2010-06-27 15:13:15 +0000
+++ doc/syncpackage.1	2010-06-29 14:24:29 +0000
@@ -1,8 +1,13 @@
-.TH SYNCPACKAGE "1" "15 April 2008" "ubuntu-dev-tools"
+.TH SYNCPACKAGE "1" "June 2010" "ubuntu-dev-tools"
 .SH NAME
 syncpackage \- helper to prepare .changes file to upload synced packages
 .SH SYNOPSIS
+<<<<<<< TREE
 .B syncpacage\fR \fB[OPTIONS]\fR \fB<.dsc file>\fR
+=======
+.B syncpackage
+[\fIoptions\fR] \fI<.dsc URL/path or package name>\fR
+>>>>>>> MERGE-SOURCE
 .SH DESCRIPTION
 \fBsyncpackage\fR generates a changes file to be directly uploaded to Ubuntu
 primary archive or PPA starting from a pristine Debian package.
@@ -10,7 +15,10 @@
 \fBsyncpackage\fR allows you to upload files with the same checksums of the
 Debian ones, as the common script used by Ubuntu archive administrators does,
 this way you can preserve source files integrity between the two distributions.
+.PP
+\fBsyncpackage\fR will detect source tarballs with mismatching checksums and will automatically create fake syncs instead.
 .SH OPTIONS
+<<<<<<< TREE
 .B <.dsc file>
 This is the .dsc file to generate .changes file against.
 .TP
@@ -45,7 +53,44 @@
 .TP
 .B -v, --verbose
 Display more information
+=======
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show help message and exit
+.TP
+\fB\-d\fR DIST, \fB\-\-distribution\fR=\fIDIST\fR
+Debian distribution to sync from.
+.TP
+\fB\-r\fR RELEASE, \fB\-\-release\fR=\fIRELEASE\fR
+Specify target Ubuntu release.
+.TP
+\fB\-V\fR DEBVERSION, \fB\-\-debian\-version\fR=\fIDEBVERSION\fR
+Specify the version to sync from.
+.TP
+\fB\-c\fR COMPONENT, \fB\-\-component\fR=\fICOMPONENT\fR
+Specify the component to sync from.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+print more information
+.TP
+\fB\-u\fR UPLOADER, \fB\-\-uploader\fR=\fIUPLOADER\fR
+Use UPLOADER as the name and email address of the
+maintainer for this upload instead of evaluating
+DEBFULLNAME and DEBEMAIL.
+.TP
+\fB\-k\fR KEYID, \fB\-\-key\fR=\fIKEYID\fR
+Specify the key ID to be used for signing.
+.TP
+\fB\-b\fR BUG, \fB\-\-bug\fR=\fIBUG\fR
+Mark a Launchpad bug as being fixed by this upload
+.PP
+>>>>>>> MERGE-SOURCE
 .SH AUTHOR
+<<<<<<< TREE
+=======
+\fBsyncpackage\fR was written by Martin Pitt <[e-mail]> and Benjamin Drung <[e-mail]>.
+.PP
+>>>>>>> MERGE-SOURCE
 This manual page were written by Luca Falavigna <[e-mail]>
 .PP
-It is released under GNU General Public License, version 3.
+Both are released under GNU General Public License, version 3.

=== modified file 'doc/ubuntu-build.1'
--- doc/ubuntu-build.1	2009-11-30 22:01:47 +0000
+++ doc/ubuntu-build.1	2010-06-29 14:24:29 +0000
@@ -1,11 +1,9 @@
-.TH UBUNTU-BUILD "1" "14 August 2008" "ubuntu-dev-tools"
+.TH UBUNTU-BUILD "1" "June 2010" "ubuntu-dev-tools"
 .SH NAME
 ubuntu-build \- command-line interface to Launchpad build operations
 
 .SH SYNOPSIS
 .B ubuntu-build <srcpackage> <release> <operation>
-.br
-.B ubuntu-build \-\-help
 
 .SH DESCRIPTION
 \fBubuntu-build\fR provides a command line interface to the Launchpad build
@@ -38,10 +36,38 @@
 .B \-h or \-\-help
 Display a help message and exit.
 .TP
-.B \-a or \-\-architecture
-Only available for \fIrescore\fR and \fIretry\fR operations only.
-This will only request the rebuilding/rescoring on the specified
-architecture.
+Retry and rescore options:
+.IP
+These options may only be used with the 'retry' and 'rescore'
+operations.
+.IP
+\fB\-a\fR ARCHITECTURE, \fB\-\-arch\fR=\fIARCHITECTURE\fR
+Rebuild or rescore a specific architecture. Valid
+architectures include: amd64, sparc, powerpc, i386,
+armel, ia64, lpia, hppa.
+.TP
+Batch processing:
+.IP
+These options and parameter ordering is only available in \fB\-\-batch\fR
+mode. Usage: ubuntu\-build \fB\-\-batch\fR [options] <package>...
+.IP
+\fB\-\-batch\fR
+Enable batch mode
+.IP
+\fB\-\-series\fR=\fISERIES\fR
+Selects the Ubuntu series to operate on (default:
+current development series)
+.IP
+\fB\-\-retry\fR
+Retry builds (give\-back).
+.IP
+\fB\-\-rescore\fR=\fIPRIORITY\fR
+Rescore builds to <priority>.
+.IP
+\fB\-\-arch2\fR=\fIARCHITECTURE\fR
+Affect only 'architecture' (can be used several
+times). Valid architectures are: amd64, sparc,
+powerpc, i386, armel, ia64, lpia, hppa.
 
 .SH AUTHORS
 \fBubuntu-build\fR was written by Martin Pitt <[e-mail]>, and

=== added file 'doc/ubuntu-iso.1'
--- doc/ubuntu-iso.1	1970-01-01 00:00:00 +0000
+++ doc/ubuntu-iso.1	2010-06-29 14:24:29 +0000
@@ -0,0 +1,16 @@
+.TH UBUNTU_ISO "1" "June 2010" "ubuntu-dev-tools"
+.SH NAME
+\fBubuntu-iso\fR \- tool to examine Ubuntu CD (ISO) installation media
+
+.SH SYNOPSIS
+\fBubuntu-iso\fR <path to ISO>
+
+.SH DESCRIPTION
+When given a path to an ISO, \fBubuntu-iso\fR will determine whether it is an an Ubuntu ISO or not. If it is, it will extract and display the version information.
+
+.SH AUTHORS
+\fBubuntu-iso\fR was written by Matt Zimmerman <[e-mail]>.
+
+This manual page was written by Andrew Starr-Bochicchio <[e-mail]>.
+.PP
+Both are released under the terms of the GNU General Public License, version 2.