Many changes (most related to manpages).

This commit is contained in:
Siegfried-Angel Gevatter Pujals 2008-02-17 18:29:47 +01:00
parent 90be92d8d5
commit abaa5f068a
10 changed files with 113 additions and 64 deletions

View File

@ -8,7 +8,6 @@
# Based upon cobwuilder's autocompletion, Copyright 2007 Cyril
# Brulebois <cyril.brulebois@enst-bretagne.fr>
have pbuilder-dist &&
_pbuilder-dist()
{

View File

@ -63,4 +63,4 @@ do
diff -u /tmp/$LIBNAME.{1,2};
rm /tmp/$LIBNAME.{1,2};
done;
done
done

6
debian/changelog vendored
View File

@ -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) <rainct@ubuntu.com> Sun, 17 Feb 2008 17:36:11 +0100

4
debian/rules vendored
View File

@ -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

View File

@ -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

21
doc/404main.1 Normal file
View File

@ -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 <petesavage@ubuntu.com> and
this manpage by Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com>.
.PP
Both are released under the GNU General Public License, version 2 or
later.

View File

@ -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 <daniel.holbach@ubuntu.com>
and this manpage by Albert Damen <albrt@gmx.net>. Both are licensed
under the GNU General Public License, version 2.

View File

@ -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 <rainct@ubuntu.com>.
They are released under the GNU General Public License, version 3 or later.
Gevatter Pujals <rainct@ubuntu.com>. They are released under the GNU General Public
License, version 3 or later.

View File

@ -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 <rainct@ubuntu.com>, based upon
a script with the same name, by Martin Pitt <martin.pitt@ubuntu.com>.
.\"
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 <rainct@ubuntu.com>, based upon a
script with the same name from Martin Pitt <martin.pitt@ubuntu.com>.
.PP
Both are released under the GNU General Public License, version 3 or later.

34
doc/update-maintainer.1 Normal file
View File

@ -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=<PATH>\fR] [\fI\-\-section=<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=<PATH>\fP
This option allows you to specify the path to the source directory.
.TP
\fB\-\-section=<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 <lut1n.tne@gmail.com>
and this manual page by Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com>.
.PP
Both are released under the GNU General Public License, version 2.