Add manpage for check-symbols. General QA

This commit is contained in:
Siegfried-Angel Gevatter Pujals (RainCT) 2007-12-17 00:24:59 +01:00
parent 54221acd74
commit bc45b6e681
5 changed files with 75 additions and 5 deletions

View File

@ -1,3 +1,4 @@
Albert Damen <albrt@gmx.net>
Albin Tonnerre <lut1n.tne@gmail.com> Albin Tonnerre <lut1n.tne@gmail.com>
Daniel Holbach <daniel.holbach@ubuntu.com> Daniel Holbach <daniel.holbach@ubuntu.com>
Jamin W. Collins <jcollins@asgardsrealm.net> Jamin W. Collins <jcollins@asgardsrealm.net>

5
debian/changelog vendored
View File

@ -4,6 +4,11 @@ ubuntu-dev-tools (0.23ubuntu1) UNRELEASED; urgency=low
- Print a list of files that have been modified outside debian/ - Print a list of files that have been modified outside debian/
- Add -h and -q options - Add -h and -q options
- Add proper exit values - Add proper exit values
* debian/control:
- Bump standards version to 3.7.3
- Move python-central to Build-Depends-Indep
- Rename XS-Vcs-* fields to Vcs-*
- Bump minimum cdbs version to 0.4.49
-- Siegfried-Angel Gevatter Pujals (RainCT) <sgevatter@ubuntu.cat> Sun, 09 Dec 2007 18:03:27 +0100 -- Siegfried-Angel Gevatter Pujals (RainCT) <sgevatter@ubuntu.cat> Sun, 09 Dec 2007 18:03:27 +0100

10
debian/control vendored
View File

@ -2,13 +2,13 @@ Source: ubuntu-dev-tools
Section: devel Section: devel
Priority: optional Priority: optional
Maintainer: Ubuntu MOTU Developers <ubuntu-motu@lists.ubuntu.com> Maintainer: Ubuntu MOTU Developers <ubuntu-motu@lists.ubuntu.com>
XS-Vcs-Bzr: https://launchpad.net/ubuntu-dev-tools/ Vcs-Bzr: https://launchpad.net/ubuntu-dev-tools/
XS-Vcs-Browser: http://codebrowse.launchpad.net/~ubuntu-dev/ubuntu-dev-tools/trunk/changes Vcs-Browser: http://codebrowse.launchpad.net/~ubuntu-dev/ubuntu-dev-tools/trunk/changes
Build-Depends: cdbs (>= 0.4.43), debhelper (>= 5), python-central (>= 0.5), python-all-dev (>= 2.4) Build-Depends: cdbs (>= 0.4.49), debhelper (>= 5), python-all-dev (>= 2.4)
Build-Depends-Indep: docbook2x Build-Depends-Indep: docbook2x, python-central (>= 0.5)
XS-Python-Version: all XS-Python-Version: all
Homepage: https://launchpad.net/ubuntu-dev-tools/ Homepage: https://launchpad.net/ubuntu-dev-tools/
Standards-Version: 3.7.2 Standards-Version: 3.7.3
Package: ubuntu-dev-tools Package: ubuntu-dev-tools
Architecture: all Architecture: all

2
debian/copyright vendored
View File

@ -2,6 +2,7 @@ This package was re-debianized by Daniel Holbach <daniel.holbach@ubuntu.com> on
Fri, 01 Jun 2007 11:30:08 +0200. Fri, 01 Jun 2007 11:30:08 +0200.
Upstream Author: Upstream Author:
Albert Damen <albrt@gmx.net>
Albin Tonnerre <lut1n.tne@gmail.com> Albin Tonnerre <lut1n.tne@gmail.com>
Daniel Holbach <daniel.holbach@ubuntu.com> Daniel Holbach <daniel.holbach@ubuntu.com>
Jamin W. Collins <jcollins@asgardsrealm.net> Jamin W. Collins <jcollins@asgardsrealm.net>
@ -19,6 +20,7 @@ Upstream Author:
Copyright: Copyright:
Copyright 2006-2007 (C) Canonical Ltd. Copyright 2006-2007 (C) Canonical Ltd.
Albert Damen <albrt@gmx.net> 2007
Albin Tonnerre <lut1n.tne@gmail.com> 2006-2007 Albin Tonnerre <lut1n.tne@gmail.com> 2006-2007
Daniel Holbach <daniel.holbach@ubuntu.com> 2006-2007 Daniel Holbach <daniel.holbach@ubuntu.com> 2006-2007
Luke Yelavich <themuso@ubuntu.com> 2006-2007 Luke Yelavich <themuso@ubuntu.com> 2006-2007

62
doc/check-symbols.1 Normal file
View File

@ -0,0 +1,62 @@
.\" 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.
\fBcheck-symbols\fP will first determine the symbols exported by the existing
and installed libary version, then install the new library and compare the
symbols exported by the new library version with the symbols exported
by the old version. For each of the symbols found, \fBcheck-symbols\fP
will list if the symbol is new, unchanged or has been removed in the
new library version.
.PP
In case the source package contains multiple binary library packages,
all library files in each of the binary packages will be verified.
.PP
\fBcheck\-symbols\fP uses \fBnm\fP -D to determine
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:
.RS 2
.TP 2
\(bu Use \fBnm\fP -D to determine the exported symbols of the old,
installed versions of the libraries provided by telepathy\-glib.
.TP 2
\(bu Install the binary libaries provided by the new version of
telepathy\-glib.
.TP 2
\(bu Compare the output of \fBnm\fP -D of the new libraries with the
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)