From abaa5f068a192eb8458f0ad437c9a7361767492e Mon Sep 17 00:00:00 2001 From: Siegfried-Angel Gevatter Pujals Date: Sun, 17 Feb 2008 18:29:47 +0100 Subject: [PATCH] Many changes (most related to manpages). --- .../pbuilder-dist | 1 - check-symbols | 2 +- debian/changelog | 6 ++- debian/rules | 4 -- debian/ubuntu-dev-tools.install | 1 + doc/404main.1 | 21 +++++++++ doc/check-symbols.1 | 26 +++++------ doc/get-build-deps.1 | 43 ++++++++++--------- doc/suspicious-source.1 | 39 ++++++++--------- doc/update-maintainer.1 | 34 +++++++++++++++ 10 files changed, 113 insertions(+), 64 deletions(-) rename pbuilder-dist.bash_completion => bash_completion/pbuilder-dist (99%) create mode 100644 doc/404main.1 create mode 100644 doc/update-maintainer.1 diff --git a/pbuilder-dist.bash_completion b/bash_completion/pbuilder-dist similarity index 99% rename from pbuilder-dist.bash_completion rename to bash_completion/pbuilder-dist index a8c065f..3011775 100644 --- a/pbuilder-dist.bash_completion +++ b/bash_completion/pbuilder-dist @@ -8,7 +8,6 @@ # Based upon cobwuilder's autocompletion, Copyright 2007 Cyril # Brulebois - have pbuilder-dist && _pbuilder-dist() { diff --git a/check-symbols b/check-symbols index 5498107..ccc74c7 100755 --- a/check-symbols +++ b/check-symbols @@ -63,4 +63,4 @@ do diff -u /tmp/$LIBNAME.{1,2}; rm /tmp/$LIBNAME.{1,2}; done; -done +done diff --git a/debian/changelog b/debian/changelog index a4c2827..292b63e 100644 --- a/debian/changelog +++ b/debian/changelog @@ -21,10 +21,14 @@ ubuntu-dev-tools (0.26) UNRELEASED; urgency=low robust and less code duplication. [ Siegfried-Angel Gevatter Pujals (RainCT) ] - * Add a manpage for update-maintainer. + * Add manpages for update-maintainer and 404main. + * Move pbuilder-dist.bash_completion into new bash_completion/ + directory and tell dh_install to take care of the stuff there. * Let update-maintainer also accept --no-changelog (in addition to the current --nochangelog), improve its error messages and change the default section to universe. + * Add AUTHORS section to doc/check-symbols.1, and little changes to + doc/suspicious-source.1. -- Siegfried-Angel Gevatter Pujals (RainCT) Sun, 17 Feb 2008 17:36:11 +0100 diff --git a/debian/rules b/debian/rules index c9d7a1c..c2b9d93 100755 --- a/debian/rules +++ b/debian/rules @@ -10,9 +10,5 @@ DEB_INSTALL_MANPAGES_ubuntu-dev-tools = doc/*.1 build/ubuntu-dev-tools:: docbook2x-man doc/ppaput.1.docbook; mv ppaput.1 doc -install/ubuntu-dev-tools:: - mkdir -p debian/ubuntu-dev-tools/etc/bash_completion.d/ - cp -v pbuilder-dist.bash_completion debian/ubuntu-dev-tools/etc/bash_completion.d/pbuilder-dist - clean:: rm -f doc/ppaput.1 diff --git a/debian/ubuntu-dev-tools.install b/debian/ubuntu-dev-tools.install index 9e3c460..f410afb 100644 --- a/debian/ubuntu-dev-tools.install +++ b/debian/ubuntu-dev-tools.install @@ -15,3 +15,4 @@ debian/tmp/usr/bin/submittodebian debian/tmp/usr/bin/suspicious-source debian/tmp/usr/bin/update-maintainer debian/tmp/usr/bin/what-patch +bash_completion/* etc/bash_completion.d/pbuilder-dist diff --git a/doc/404main.1 b/doc/404main.1 new file mode 100644 index 0000000..f661f6d --- /dev/null +++ b/doc/404main.1 @@ -0,0 +1,21 @@ +.TH 404main 1 "February 17, 2008" "ubuntu-dev-tools" + +.SH NAME +404main \- check if all build dependencies of a package are in main + +.SH SYNOPSIS +\fB404main\fP <\fIpackage name\fP> + +.SH DESCRIPTION +\fB404main\fP is a script that can be used to check if a package and +all its build dependencies are in Ubuntu's main component or not. + +.SH SEE ALSO +.BR apt-cache (8) + +.SH AUTHORS +\fB404main\fP was written by Pete Savage and +this manpage by Siegfried-Angel Gevatter Pujals . +.PP +Both are released under the GNU General Public License, version 2 or +later. diff --git a/doc/check-symbols.1 b/doc/check-symbols.1 index 84857aa..8abb439 100644 --- a/doc/check-symbols.1 +++ b/doc/check-symbols.1 @@ -1,19 +1,11 @@ -.\" Title: check-symbols -.\" Author: Albert Damen -.\" Contact details: albrt@gmx.net -.\" -.\" Copyright (C), 2007, Albert Damen -.\" -.\" Permission is granted to copy, distribute and/or modify this document under -.\" the terms of the GNU General Public License version 2. -.\" .TH "CHECK\-SYMBOLS" "1" "December 9, 2007" "ubuntu-dev-tools" + .SH "NAME" check\-symbols \- verify symbols exported by a new library version -.\" + .SH "SYNOPSIS" \fBcheck\-symbols\fP <\fIsource\-package\fR\> [\fIDEBDIR\fR] -.\" + .SH "DESCRIPTION" To verify the symbols exported by a new library version, run \fBcheck-symbols\fP with the name of the source package as argument. @@ -32,9 +24,8 @@ the exported symbols of the libraries. .PP If no value is given for DEBDIR, the script will assume the new library deb files are stored in /var/cache/pbuilder/result. -.\" + .SH "EXAMPLES" -.TP \fBcheck\-symbols\fP telepathy-glib . .TP This will: @@ -51,12 +42,17 @@ output of the old version. .TP 2 \(bu List the result in diff format. .RE -.\" + .SH "BUGS" .nf Please report bugs on: https://bugs.launchpad.net/ubuntu/+source/ubuntu\-dev\-tools/ .fi -.\" + .SH "SEE ALSO" .BR nm (1) + +.SH "AUTHOR" +\fBcheck\-symbols\fP was written by Daniel Holbach +and this manpage by Albert Damen . Both are licensed +under the GNU General Public License, version 2. diff --git a/doc/get-build-deps.1 b/doc/get-build-deps.1 index 66ad7b4..2077f8b 100644 --- a/doc/get-build-deps.1 +++ b/doc/get-build-deps.1 @@ -7,28 +7,28 @@ get\-build\-deps \- install build dependencies for one or more packages \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. +\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. .PP -In order to obtain all missing build dependencies for a package on which source -you are currently working, just run this script without any argument, and it'll -read its debian/control file to determine the missing build dependencies. +In order to obtain all missing build dependencies for a package on +which source you are currently working, just run this script without +any argument, and it'll read its debian/control file to determine the +missing build dependencies. .PP -Alternatively, you can call it with a list of space-separated package names, or the -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". +Alternatively, you can call it with a list of space-separated package +names, or the 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 -Looks for a debian/control file in the current working directory and installs the -dependencies listed there. +Looks for a debian/control file in the current working directory and +installs the dependencies listed there. .TP get\-build\-deps geany -Installs the build dependencies for the version of -.B geany -that's in the repositories. +Installs the build dependencies for the version of \fBgeany\fP that's +in the repositories. .TP get\-build\-deps geany epiphany-browser rhythmbox Same as the previous example but also with the dependencies for @@ -40,13 +40,14 @@ get\-build\-deps ./package_list.txt Reads the file .B package_list.txt (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. +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. +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), @@ -54,5 +55,5 @@ the indicated versions, but just installs the newest one available in the reposi .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. +Gevatter Pujals . They are released under the GNU General Public +License, version 3 or later. diff --git a/doc/suspicious-source.1 b/doc/suspicious-source.1 index 2b39695..967fba5 100644 --- a/doc/suspicious-source.1 +++ b/doc/suspicious-source.1 @@ -1,30 +1,27 @@ -.\" Title: suspicious-source -.\" Author: Siegfried-Angel Gevatter Pujals -.\" Contact details: rainct@ubuntu.com -.\" .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" -.\" +suspicious\-source \- search for files that are not the GPL's +"preferred form of modification" + .SH SYNOPSIS \fBsuspicious\-source\fP -.\" + .SH DESCRIPTION -\fBsuspicious\-source\fP is a script that outputs 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 "preferred form of modification" +\fBsuspicious\-source\fP is a script that outputs 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 "preferred form of modification" that the GPL and other licenses require. .PP -Neither the files inside version control system directories (like ".bzr/" or "CVS/"), nor those inside "debian/" are -considered. -.\" -.SH AUTHORS -\fBsuspicious\-source\fP has been written by Siegfried-Angel Gevatter Pujals , based upon -a script with the same name, by Martin Pitt . -.\" +Neither the files inside version control system directories (like +".bzr/" or "CVS/"), nor those inside "debian/" are considered. + .SH SEE ALSO .BR find (1) -.\" -.SH COPYRIGHT -This manual page was written by Siegfried-Angel Gevatter Pujals (RainCT). -It is released under the GNU General Public License, version 2 or later. + +.SH AUTHORS +\fBsuspicious\-source\fP and this manpage have been written by +Siegfried-Angel Gevatter Pujals , based upon a +script with the same name from Martin Pitt . +.PP +Both are released under the GNU General Public License, version 3 or later. diff --git a/doc/update-maintainer.1 b/doc/update-maintainer.1 new file mode 100644 index 0000000..8d19e15 --- /dev/null +++ b/doc/update-maintainer.1 @@ -0,0 +1,34 @@ +.TH UPDATE\-MAINTAINER "1" "February 17, 2008" "ubuntu-dev-tools" + +.SH NAME +update\-maintainer \- change Maintainer field in a Debian source package + +.SH SYNOPSIS +.B update\-maintainer [\fI\-\-path=\fR] [\fI\-\-section=
\fR] [\fI\-\-nochangelog\fR] + +.SH DESCRIPTION +\fBupdate\-maintainer\fP updates the Maintainer field in the source of +an Ubuntu package to match the DebianMaintainerField specification. +.PP +See https://wiki.ubuntu.com/DebianMaintainerField for more information. + +.SH OPTIONS +.TP +\fB\-\-path=\fP +This option allows you to specify the path to the source directory. +.TP +\fB\-\-section=
\fP +Manually specify the section of the package. This is necessary if the +package is not yet in the archive or if you don't have an Internet +connection available when you run \fBupdate\-maintainer\fP. +.TP +\fB\-\-nochangelog\fP +By default, \fBupdate\-maintainer\fP adds an entry to the changelog +explaining that it changed the Maintainer field. If you don't want +that to happen, use this option. + +.SH AUTHOR +\fBupdate-maintainer\fP has been written by Albin Tonnerre +and this manual page by Siegfried-Angel Gevatter Pujals . +.PP +Both are released under the GNU General Public License, version 2.