From 19e5ab20f661933fd5bd335a7b53dcf37aa30f8b Mon Sep 17 00:00:00 2001 From: "Siegfried-Angel Gevatter Pujals (RainCT)" Date: Thu, 17 Jan 2008 21:04:34 +0100 Subject: [PATCH] Add a manpage for reverse-build-depends; add the text 'ubuntu-dev-tools' to the footer of all manpages (except ppaput); update the README file to add 4 or 5 missing scripts; some other change? --- README | 68 ++++++++++++++++++++++++------------- debian/changelog | 6 +++- debian/copyright | 16 +++------ debian/pycompat | 1 + doc/get-build-deps.1 | 20 +++++------ doc/pbuilder-dist.1 | 24 ++++++------- doc/requestsync.1 | 2 +- doc/reverse-build-depends.1 | 39 +++++++++++++++++++++ doc/submittodebian.1 | 2 +- doc/suspicious-source.1 | 2 +- 10 files changed, 120 insertions(+), 60 deletions(-) create mode 100644 debian/pycompat create mode 100644 doc/reverse-build-depends.1 diff --git a/README b/README index a56a5e9..34c918f 100644 --- a/README +++ b/README @@ -7,32 +7,44 @@ are in the "main" component or not. check-symbols [] - ... will compare and give you a diff of the exported symbols of all .so - files in all binary packages of . - is not mandatory and set to /var/cache/pbuilder/result by default. + ... will compare and give you a diff of the exported symbols of all + .so files in all binary packages of . is not + mandatory and set to /var/cache/pbuilder/result by default. dch-repeat [--help] ... will repeat a change log into an older release. +dgetlp + ... will simulate «dget»'s behaviour for files hosted at + launchpadlibrarian.net. + get-branches [checkout|branch] - ... will branch / checkout all the Bazaar branches in a Launchpad team. + ... will branch / checkout all the Bazaar branches in a Launchpad + team. get-build-deps [] - ... will install the build dependencies for a package, if you are inside - its source file. Alternatively, you can pass it the name of a file - containing a list of packages, one on each line, or just pass them all - as parameters, and it will get their build dependencies. + ... will install the build dependencies for a package, if you are + inside its source file. Alternatively, you can pass it the name of + a file containing a list of packages, one on each line, or just + pass them all as parameters, and it will get their build + dependencies. hugdaylist [-n ] ... will create a list of bug list for a hug day listing +massfile + ... will perform a massive bug reporting operation on Launchpad + according to the information in the "information" and "list" files + that are in the working directory. + mk-sbuild-lv - ... will create LVM snapshot chroots via schroot and sbuild. It assumes that - sbuild has not be installed and configured before. + ... will create LVM snapshot chroots via schroot and sbuild. It + assumes that sbuild has not be installed and configured before. pbuilder-dist [withlog] [create|update|build|clean|login|execute] - ... is a wrapper to use pbuilder with many different distributions / versions. - It has to be renamed to something like pbuilder-feisty, pbuilder-gutsy, etc. + ... is a wrapper to use pbuilder with many different Ubuntu and/or + Debian releases. It's recommended to symlink as pbuilder-feisty, + pbuilder-gutsy, etc. ppaput [-n] [] ... will build a source package using , upload it @@ -41,22 +53,32 @@ ppaput [-n] [] '-n' is used. pull-debian-debdiff - ... will attempt to find and download a specific version of a Debian package - and its immediate parent to generate a debdiff. + ... will attempt to find and download a specific version of a + Debian package and its immediate parent to generate a debdiff. requestsync [-n|-s] [base version] - ... will file a sync request for a package from Debian by sending a bug report to - Launchpad. + ... will file a sync request for a package from Debian by sending + a bug report to Launchpad. + +reverse-build-depends [-c|-s] + ... will print 's build dependencies. + +submittodebian + ... will submit patches to Debian's BTS. Run it from inside the + source directory of a Debian package (note that there has to be + a .dsc for it in the parent directory). suspicious-source - ... will output a list of files which are not common source files. This should be - run in the root of a source tree to find files which might not be the "prefered - form of modification" that the GPL and other licenses require. + ... will output a list of files which are not common source files. + This should be run in the root of a source tree to find files which + might not be the "prefered form of modification" that the GPL and + other licenses require. update-maintainer - ... will update the maintainer field of an Ubuntu package to match the - DebianMaintainerField specification. + ... will update the Maintainer field of an Ubuntu package to match + the DebianMaintainerField specification, and add a line about this + to the changelog. what-patch - ... will check what patching system is used by a package. - You need to be in its source directory in order that it works. + ... will check what patching system is used by a package. You need + to be in its source directory in order for it to work. diff --git a/debian/changelog b/debian/changelog index 929e9dd..69b61e5 100644 --- a/debian/changelog +++ b/debian/changelog @@ -16,7 +16,11 @@ ubuntu-dev-tools (0.25) UNRELEASED; urgency=low - Bump minimum cdbs version to 0.4.49. * Add Albert Damen to the Authors and Copyright Holders. * Change my email address (to @ubuntu.com) everywhere. - * Add reverse-build-depends script. + * Add reverse-build-depends script and a manpage for it. + * Add requestsync and reverse-build-depends and massfile to + debian/copyright. + * Update README (add information for many missing scripts). + * Add the text "ubuntu-dev-tools" to the footer of all manpages. -- Siegfried-Angel Gevatter Pujals (RainCT) Thu, 17 Jan 2008 19:17:43 +0100 diff --git a/debian/copyright b/debian/copyright index cbd9af9..f8c14e1 100644 --- a/debian/copyright +++ b/debian/copyright @@ -34,8 +34,8 @@ Copyright: Licenses: 404main, check-symbols, dch-repeat, dgetlp, mk-sbuild-lv, pbuilder-dist, -pull-debian-debdiff, submittodebian, update-maintainer, and what-patch -are licensed under GPLv2: +pull-debian-debdiff, requestsync, reverse-build-depends, submittodebian, +update-maintainer and what-patch are licensed under GPLv2: This package is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -45,15 +45,12 @@ are licensed under GPLv2: but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this package; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA On Debian systems, the complete text of the GNU General Public License v2 can be found in `/usr/share/common-licenses/GPL-2'. -get-branches, suspicious-source and get-build-deps are licensed under GPLv3: +get-branches, get-build-deps, massfile andsuspicious-source are licensed +under GPLv3: This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -64,12 +61,9 @@ get-branches, suspicious-source and get-build-deps are licensed under GPLv3: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see . - On Debian systems, the complete text of the GNU General Public License v3 can be found in `/usr/share/common-licenses/GPL-3'. The following of the scripts can be used, at your option, regarding any later version of the previously specified license: 404main, pbuilder-dist, -dgetlp, suspicious-source and get-build-deps. +dgetlp, reverse-build-depends, suspicious-source and get-build-deps. diff --git a/debian/pycompat b/debian/pycompat new file mode 100644 index 0000000..0cfbf08 --- /dev/null +++ b/debian/pycompat @@ -0,0 +1 @@ +2 diff --git a/doc/get-build-deps.1 b/doc/get-build-deps.1 index e530e73..42747e5 100644 --- a/doc/get-build-deps.1 +++ b/doc/get-build-deps.1 @@ -1,15 +1,15 @@ .\" Title: get-build-deps .\" Author: Siegfried-Angel Gevatter Pujals .\" Contact details: rainct@ubuntu.com -.\" -.TH GET\-BUILD\-DEPS 1 "October 27, 2007" -.\" + +.TH GET\-BUILD\-DEPS 1 "October 27, 2007" "ubuntu-dev-tools" + .SH NAME get\-build\-deps \- install build dependencies for one or more packages -.\" + .SH SYNOPSIS -\fBget\-build\-deps\fP [\fIPACKAGE\fR...] -.\" +\fBget\-build\-deps\fP [\fIpackage name\fR] + .SH DESCRIPTION \fBget\-build\-deps\fP is a script to install the build dependencies for either a local source package or one or more packages from the repositories. @@ -22,7 +22,7 @@ Alternatively, you can call it with a list of space-separated package names, or name of a single file which contains the package names each on a line. Then it will install the missing dependencies for those packages using "apt-get build-dep". -.\" + .SH EXAMPLES .TP get\-build\-deps @@ -46,17 +46,17 @@ Reads the file (relative to the current working directory), where each line contains the name of a package, and installs the dependencies for the versions of all those that are in the repositories. -.\" + .SH KNOWN BUGS AND LIMITATIONS When it's being used to install the missing dependencies for a local source package (i.e., no arguments are passed to it) it doesn't check for the dependencies to match the indicated versions, but just installs the newest one available in the repositories. -.\" + .SH SEE ALSO .BR dpkg-checkbuilddeps (1), .BR apt-get (8) .SH AUTHORS -.\" + \fBget\-build\-deps\fP and this manual page have been written by Siegfried-Angel Gevatter Pujals . They are released under the GNU General Public License, version 3 or later. diff --git a/doc/pbuilder-dist.1 b/doc/pbuilder-dist.1 index 965be5d..d271128 100644 --- a/doc/pbuilder-dist.1 +++ b/doc/pbuilder-dist.1 @@ -1,16 +1,16 @@ .\" Title: pbuilder-dist .\" Author: Siegfried-Angel Gevatter Pujals .\" Contact details: rainct@ubuntu.com -.\" -.TH PBUILDER\-DIST 1 "August 16, 2007" -.\" + +.TH PBUILDER\-DIST 1 "August 16, 2007" "ubuntu-dev-tools" + .SH NAME pbuilder\-dist \- multi-distribution pbuilder wrapper -.\" + .SH SYNOPSIS \fBpbuilder\-dist\fP \fIdistribution\fR [\fBi386\fP|\fBamd64\fP] [\fBmainonly\fP|\fBallcomp\fP] [\fBwithlog\fP|\fBnolog\fP] \fIoperation\fR [\fI...\fR] -.\" + .SH DESCRIPTION \fBpbuilder\-dist\fP is a wrapper that makes it easy to use pbuilder with many different versions of Ubuntu and/or Debian. @@ -18,7 +18,7 @@ versions of Ubuntu and/or Debian. It is common to symlink this script in order to give it many names in the form of \fBpbuilder\-\fIdistribution\fP\fR (\fBpbuilder\-\fIdistribution\fR\-\fIarchitecture\fP\fR on amd64 systems), like for example \fBpbuilder\-feisty\fP, \fBpbuilder\-sid\fP, \fBpbuilder\-gutsy\-i386\fP, etc. -.\" + .SH USAGE There are many arguments listed on the synopsis; each of them, if used, has to be used exactly in the same order as it appears there. @@ -64,7 +64,7 @@ The default value of all optional parameters (except the architecture) can be ch editing the first lines of the script. You can also change the base directory using the global variable $PBUILDFOLDER. .PP -.\" + .SH EXAMPLES .TP pbuilder\-dist gutsy create @@ -81,30 +81,30 @@ Same as above, but stores \fBpbuilder\fP's output on a file. .TP pbuilder\-etch i386 update Updates an existing i386-architecture Debian Etch environment on an amd64 system. -.\" + .SH FILES By default, \fBpbuilder\-dist\fP will store all the files it generates in \fB~/pbuilder/\fP. This can be changed by modifying the BASE_DIR value on the top of the script to any other directory you want, or by using the $PBUILDFOLDER global variable. If it doesn't exist, it will be created on the run. -.\" + .SH BUGS There are no known bugs at the moment. If you experience any problem with this script contact me on rainct@ubuntu.com. Please ensure first that the problem is really this script and not an issue with \fBpbuilder\fP. -.\" + .SH AUTHORS \fBpbuilder\-dist\fP was originally written by Jamin W. Collins and Jordan Mantha . .PP On August 2007 it was mostly rewritten, and extended, by Siegfried-Angel Gevatter Pujals . -.\" + .SH SEE ALSO \fBpbuilder\fR, \fBpbuilderrc\fR -.\" + .SH COPYRIGHT This manual page was written by Siegfried-Angel Gevatter Pujals (RainCT) for YOU. diff --git a/doc/requestsync.1 b/doc/requestsync.1 index e356253..fda659f 100644 --- a/doc/requestsync.1 +++ b/doc/requestsync.1 @@ -1,4 +1,4 @@ -.TH REQUESTSYNC "1" "22 November 2007" "devscripts" +.TH REQUESTSYNC "1" "22 November 2007" "ubuntu-dev-tools" .SH NAME requestsync \- helper to file sync requests for Ubuntu .SH SYNOPSIS diff --git a/doc/reverse-build-depends.1 b/doc/reverse-build-depends.1 new file mode 100644 index 0000000..cd097ed --- /dev/null +++ b/doc/reverse-build-depends.1 @@ -0,0 +1,39 @@ +.\" Title: reverse-build-depends +.\" Author: Siegfried-Angel Gevatter Pujals +.\" Contact details: rainct@ubuntu.com + +.TH REVERSE\-BUILD\-DEPENDS 1 "January 17, 2008" "ubuntu-dev-tools" + +.SH NAME +reverse\-build\-depends \- find a package's reverse build dependencies + +.SH SYNOPSIS +\fBreverse\-build\-depends\fP [\fB\-c\fP|\fB\-s\fP] <\fIpackage name\fR> + +.SH DESCRIPTION +\fBreverse\-build\-depends\fP is a little script that prints a list of +all those Debian package that have a build dependency upon the package +you indicate, that is, they search for its reverse build dependencies. + +.SH OPTIONS +.TP +\fB\-c\fP +This option will disable normal output and print only the number of +reverse dependencies instead. +.TP +\fB\-s\fP +If you prefer to see all build dependencies in a single line, use this +option. Otherwise, each one will be printed on its own line. + +.SH KNOWN BUGS AND LIMITATIONS +Note that to use \fBreverse\-build\-depends\fP it is required for the source repositories +(deb-src lines) to be enabled in your sources.list. + +.SH SEE ALSO +\fBgrep\-dctrl\fR, \fBapt\-cache\fR + +.SH COPYRIGHT +\fBreverse\-build\-depends\fP and this manual page were written by +Siegfried-Angel Gevatter Pujals for YOU. Both are +released under the terms of the GNU General Public License (version 2 +or later). diff --git a/doc/submittodebian.1 b/doc/submittodebian.1 index 1379d3b..f697870 100644 --- a/doc/submittodebian.1 +++ b/doc/submittodebian.1 @@ -1,4 +1,4 @@ -.TH SUBMITTODEBIAN 1 "Dec 2007" +.TH SUBMITTODEBIAN 1 "Dec 2007" "ubuntu-dev-tools" .SH NAME submittodebian \- submit changes in Debian source tree to Debian .SH SYNOPSIS diff --git a/doc/suspicious-source.1 b/doc/suspicious-source.1 index e662b76..2b39695 100644 --- a/doc/suspicious-source.1 +++ b/doc/suspicious-source.1 @@ -2,7 +2,7 @@ .\" Author: Siegfried-Angel Gevatter Pujals .\" Contact details: rainct@ubuntu.com .\" -.TH SUSPICIOUS\-SOURCE 1 "September 14, 2007" +.TH SUSPICIOUS\-SOURCE 1 "September 14, 2007" "ubuntu-dev-tools" .\" .SH NAME suspicious\-source \- search for files that are not the GPL's "preferred form of modification"