--- Begin Message ---
Package: devscripts
Version: 2.11.0
Severity: minor
Tags: patch
Hi Benjamin (I guess you're the one who will have to deal with that bug
report),
While translating the newly added manpages, I prepared a style and
convention review of these pages (based on man(1) advices and usage).
Regards
David
-- Package-specific info:
--- /etc/devscripts.conf ---
--- ~/.devscripts ---
Not present
-- System Information:
Debian Release: wheezy/sid
APT prefers unstable
APT policy: (600, 'unstable'), (500, 'oldstable'), (500, 'stable'), (150,
'experimental')
Architecture: amd64 (x86_64)
Kernel: Linux 2.6.39-1-amd64 (SMP w/1 CPU core)
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Versions of packages devscripts depends on:
ii dpkg-dev 1.16.0.3 Debian package development tools
ii libc6 2.13-4 Embedded GNU C Library: Shared lib
ii perl 5.12.3-7 Larry Wall's Practical Extraction
ii python 2.6.6-14 interactive high-level object-orie
ii python2.6 2.6.6-10 An interactive high-level object-o
ii python2.7 2.7.1-9 An interactive high-level object-o
Versions of packages devscripts recommends:
ii at 3.1.12-1 Delayed job execution and batch pr
ii curl 7.21.6-1 Get a file from an HTTP, HTTPS or
ii dctrl-tools 2.19 Command-line tools to process Debi
ii debian-keyring [debian-m 2011.03.03 GnuPG keys of Debian Developers
ii dput 0.9.6.2 Debian package upload tool
pn equivs <none> (no description available)
ii fakeroot 1.15.1-1 tool for simulating superuser priv
ii gnupg 1.4.11-3 GNU privacy guard - a free PGP rep
ii libcrypt-ssleay-perl 0.57-2+b2 Support for https protocol in LWP
ii libjson-perl 2.53-1 module for manipulating JSON-forma
ii libparse-debcontrol-perl 2.005-3 parser for debian control-like fil
ii libsoap-lite-perl 0.712-3 Perl implementation of a SOAP clie
ii liburi-perl 1.58-1 module to manipulate and access UR
ii libwww-perl 6.02-1 simple and consistent interface to
ii lintian 2.5.0 Debian package checker
ii man-db 2.6.0.2-1 on-line manual pager
ii patch 2.6.1.85-423d-3 Apply a diff file to an original
ii patchutils 0.3.2-1 Utilities to work with patches
ii python-debian 0.1.20 Python modules to work with Debian
ii python-magic 5.04-5+b1 File type determination library us
ii sensible-utils 0.0.6 Utilities for sensible alternative
ii strace 4.5.20-2.3 A system call tracer
ii unzip 6.0-4 De-archiver for .zip files
ii wdiff 0.6.5-1 Compares two files word by word
ii wget 1.12-3.1 retrieves files from the web
ii xz-utils 5.0.0-2 XZ-format compression utilities
Versions of packages devscripts suggests:
ii build-essential 11.5 Informational list of build-essent
pn cvs-buildpackage <none> (no description available)
pn devscripts-el <none> (no description available)
ii gnuplot 4.4.0-1.1 A command-line driven interactive
pn libauthen-sasl-perl <none> (no description available)
ii libfile-desktopentry-pe 0.04-2 Perl module to handle freedesktop
pn libnet-smtp-ssl-perl <none> (no description available)
ii libterm-size-perl 0.2-4+b2 Perl extension for retrieving term
ii libtimedate-perl 1.2000-1 collection of modules to manipulat
ii libyaml-syck-perl 1.17-1+b1 Perl module providing a fast, ligh
ii mailutils [mailx] 1:2.2+dfsg1-3+b1 GNU mailutils utilities for handli
ii mutt 1.5.21-5 text-based mailreader supporting M
ii openssh-client [ssh-cli 1:5.8p1-4 secure shell (SSH) client, for sec
ii svn-buildpackage 0.8.3 helper programs to maintain Debian
ii w3m 0.5.3-2+b1 WWW browsable pager with excellent
-- no debconf information
>From c355ad0ab1f985e201db5056d1a7454196486f5e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Pr=C3=A9vot?= <[email protected]>
Date: Thu, 26 May 2011 23:43:51 -0400
Subject: [PATCH] Stylish manual pages convention review
Focused on newly added manual pages.
---
debian/control | 6 +++---
doc/edit-patch.1 | 26 +++++++++++++-------------
doc/suspicious-source.1 | 22 +++++++++++-----------
doc/what-patch.1 | 26 ++++++++++++++------------
doc/wrap-and-sort.1 | 34 +++++++++++++++++-----------------
5 files changed, 58 insertions(+), 56 deletions(-)
diff --git a/debian/control b/debian/control
index ea047b5..57ab76f 100644
--- a/debian/control
+++ b/debian/control
@@ -176,8 +176,8 @@ Description: scripts to make the life of a Debian Package
maintainer easier
- rc-alert: list installed packages which have release-critical bugs [wget]
- rmadison: remotely query the Debian archive database about packages
[wget | curl, liburi-perl]
- - suspicious-source: outputs a list of files which are not common source
- files [python-magic].
+ - suspicious-source: output a list of files which are not common source
+ files [python-magic]
- svnpath: print svn repository paths [subversion]
- tagpending: runs from a Debian source tree and tags bugs that are to
be closed in the latest changelog as pending. [libsoap-lite-perl]
@@ -187,7 +187,7 @@ Description: scripts to make the life of a Debian Package
maintainer easier
- uscan: scan upstream sites for new releases of packages
[libcrypt-ssleay-perl, libwww-perl, unzip, xz-utils]
- uupdate: integrate upstream changes into a source package [patch]
- - what-patch: determines what patch system, if any, a source package is using
+ - what-patch: determine what patch system, if any, a source package is using
[patchutils]
- whodepends: check which maintainers' packages depend on a package
- who-uploads: determine the most recent uploaders of a package to the Debian
diff --git a/doc/edit-patch.1 b/doc/edit-patch.1
index 736c4f5..5bdceb5 100644
--- a/doc/edit-patch.1
+++ b/doc/edit-patch.1
@@ -4,40 +4,40 @@
source packages
.SH SYNOPSIS
-\fBedit-patch\fR <path to patch>
+\fBedit-patch\fR \fIpath/to/patch\fR
-\fBadd-patch\fR <path to patch>
+\fBadd-patch\fR \fIpath/to/patch\fR
.SH DESCRIPTION
-\fBedit-patch\fR is a wrapper script around the quilt, cdbs, and dpatch patch
+\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.
+be used to edit existing patches located in \fI/debian/patches\fR.
It can also be used to incorporate new patches.
If pointed at a patch not already present, it will copy the patch to
-/debian/patches in the correct format for the patch system in use.
+\fI/debian/patches\fR 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 pressing Ctrl-d will close the subshell and launch an editor
-to record the debian/changelog entry.
+Typing \fBexit\fR or pressing Ctrl-d will close the subshell and launch an
editor
+to record the \fIdebian/changelog\fR 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/changelog
+\fBedit-patch\fR is integrated with the Bazaar and Git version control systems.
+The patch will be automatically added to the tree, and the
\fIdebian/changelog\fR
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.
+and a copy is stored in \fIdebian/patches-applied\fR.
\fBadd-patch\fR is the non-interactive version of \fBedit-patch\fR.
The patch will be incorporated but no editor or subshell will be
spawned.
.SH AUTHORS
-\fBedit-patch\fR was written by Daniel Holbach <[email protected]>,
-Michael Vogt <[email protected]>, and David Futcher
<[email protected]>.
+\fBedit-patch\fR was written by Daniel Holbach
<\[email protected]\fR>,
+Michael Vogt <\[email protected]\fR>, and David Futcher
<\[email protected]\fR>.
-This manual page was written by Andrew Starr-Bochicchio <[email protected]>.
+This manual page was written by Andrew Starr-Bochicchio
<\[email protected]\fR>.
.PP
Both are released under the terms of the GNU General Public License, version 3.
diff --git a/doc/suspicious-source.1 b/doc/suspicious-source.1
index fbc2bb7..31d931b 100644
--- a/doc/suspicious-source.1
+++ b/doc/suspicious-source.1
@@ -29,27 +29,27 @@ not be the "preferred form of modification" that the GPL
and other licenses
require.
.PP
The files inside version control system directories (like
-".bzr/" or "CVS/") are not considered.
+\fI.bzr/\fR or \fICVS/\fR) are not considered.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
-show this help message and exit
+Show this help message and exit.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
-print more information
+Print more information.
.TP
-\fB\-d\fR DIRECTORY, \fB\-\-directory\fR=\fIDIRECTORY\fR
-check the files in the specified directory instead of the current directory
+\fB\-d \fIdirectory\fR, \fB\-\-directory=\fIdirectory\fR
+Check the files in the specified \fIdirectory\fR instead of the current
directory.
.TP
-\fB\-m\fR MIMETYPE, \fB\-\-mimetype\fR=\fIMIMETYPE\fR
-Add MIMETYPE to list of white-listed mime-types.
+\fB\-m \fImimetype\fR, \fB\-\-mimetype=\fImimetype\fR
+Add \fImimetype\fR to list of white-listed MIME types.
.TP
-\fB\-e\fR EXTENSION, \fB\-\-extension\fR=\fIEXTENSION\fR
-Add EXTENSION to list of white-listed extensions.
+\fB\-e \fIextension\fR, \fB\-\-extension=\fIextension\fR
+Add \fIextension\fR to list of white-listed extensions.
.SH AUTHORS
-\fBsuspicious\-source\fP and this manpage has been written by
-Benjamin Drung <[email protected]>.
+\fBsuspicious\-source\fP and this manpage have been written by
+Benjamin Drung <\[email protected]\fR>.
.PP
Both are released under the ISC license.
diff --git a/doc/what-patch.1 b/doc/what-patch.1
index ce5ae6f..7ebe884 100644
--- a/doc/what-patch.1
+++ b/doc/what-patch.1
@@ -1,40 +1,42 @@
.TH WHAT\-PATCH "1" "Debian Utilities" "DEBIAN"
.SH NAME
-what\-patch \- detects which patch system a Debian package uses
+what\-patch \- detect which patch system a Debian package uses
.SH SYNOPSIS
-.B what\-patch [options]
+.B what\-patch\fR [\fIoptions\fR]
.SH DESCRIPTION
-\fBwhat\-patch\fR examines the debian/rules file to determine which patch
+\fBwhat\-patch\fR examines the \fIdebian/rules\fR file to determine which patch
system the Debian package is using.
.PP
\fBwhat\-patch\fR should be run from the root directory of the Debian source
package.
.SH OPTIONS
-Listed below are the command line options for what\-patch:
+Listed below are the command line options for \fBwhat\-patch\fR:
.TP
-.B \-h or \-\-help
+.BR \-h ", " \-\-help
Display a help message and exit.
.TP
.B \-v
Enable verbose mode.
-This will include the listing of any files modified outside or the debian/
+This will include the listing of any files modified outside or the
\fIdebian/\fR
directory and report any additional details about the patch system if
available.
.SH AUTHORS
-\fBwhat\-patch\fR was written by Kees Cook <[email protected]>,
-Siegfried-A. Gevatter <[email protected]>, and Daniel Hahler
-<[email protected]>, among others.
-This manual page was written by Jonathan Patrick Davies <[email protected]>.
+\fBwhat\-patch\fR was written by Kees Cook <\[email protected]\fR>,
+Siegfried-A. Gevatter <\[email protected]\fR>, and Daniel Hahler
+<\[email protected]\fR>, among others.
+This manual page was written by Jonathan Patrick Davies
<\[email protected]\fR>.
.PP
Both are released under the GNU General Public License, version 3 or later.
.SH SEE ALSO
The Ubuntu MOTU team has some documentation about patch systems at the Ubuntu
-wiki: \fBhttps://wiki.ubuntu.com/PackagingGuide/PatchSystems\fR
+wiki: \fIhttps://wiki.ubuntu.com/PackagingGuide/PatchSystems\fR
.PP
-.B cdbs\-edit\-patch(1), dbs\-edit\-patch(1), dpatch\-edit\-patch(1)
+.BR cdbs\-edit\-patch (1),
+.BR dbs\-edit\-patch (1),
+.BR dpatch\-edit\-patch (1)
diff --git a/doc/wrap-and-sort.1 b/doc/wrap-and-sort.1
index 3894a63..c514c5f 100644
--- a/doc/wrap-and-sort.1
+++ b/doc/wrap-and-sort.1
@@ -23,29 +23,29 @@ wrap-and-sort \- wrap long lines and sort items in Debian
packaging files
\fBwrap\-and\-sort\fP wraps the package lists in Debian control files. By
default the lists will only split into multiple lines if the entries are longer
than 80 characters. \fBwrap\-and\-sort\fP sorts the package lists in Debian
-control files and all .install files. Beside that \fBwrap\-and\-sort\fP removes
+control files and all \fI.install\fR files. Beside that \fBwrap\-and\-sort\fP
removes
trailing spaces in these files.
.PP
This script should be run in the root of a Debian package tree. It searches for
-control, control.in, copyright, copyright.in, install, and *.install in the
-debian directory.
+\fIcontrol\fR, \fIcontrol.in\fR, \fIcopyright\fR, \fIcopyright.in\fR,
\fIinstall\fR, and \fI*.install\fR in the
+\fIdebian\fR directory.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
-show this help message and exit
+Show this help message and exit.
.TP
\fB\-a\fR, \fB\-\-wrap\-always\fR
-wrap all package lists in the Debian control file
+Wrap all package lists in the Debian \fIcontrol\fR file
even if the entries are shorter than 80 characters and could fit in one line
-line
+line.
.TP
\fB\-s\fR, \fB\-\-short\-indent\fR
-only indent wrapped lines by one space (default is in\-line with the
-field name)
+Only indent wrapped lines by one space (default is in\-line with the
+field name).
.TP
\fB\-b\fR, \fB\-\-sort\-binary\-packages\fR
-sort binary package paragraphs by name
+Sort binary package paragraphs by name.
.TP
\fB\-k\fR, \fB\-\-keep\-first\fR
When sorting binary package paragraphs, leave the first one at the top.
@@ -54,21 +54,21 @@ Unqualified
configuration files are applied to the first package.
.TP
\fB\-n\fR, \fB\-\-no\-cleanup\fR
-do not remove trailing whitespaces
+Do not remove trailing whitespaces.
.TP
-\fB\-d \fIPATH\fR, \fB\-\-debian\-directory\fR=\fIPATH\fR
-location of the \fIdebian\fR directory (default: \fB./debian\fR)
+\fB\-d \fIpath\fR, \fB\-\-debian\-directory=\fIpath\fR
+Location of the \fIdebian\fR directory (default: \fI./debian\fR).
.TP
-\fB\-f\fI FILE\fR, \fB\-\-file\fR=\fIFILE\fR
-Wrap and sort only the specified file.
+\fB\-f \fIfile\fR, \fB\-\-file=\fIfile\fR
+Wrap and sort only the specified \fIfile\fR.
You can specify this parameter multiple times.
All supported files will be processed if no files are specified.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
-print all files that are touched
+Print all files that are touched.
.SH AUTHORS
-\fBwrap\-and\-sort\fP and this manpage has been written by
-Benjamin Drung <[email protected]>.
+\fBwrap\-and\-sort\fP and this manpage have been written by
+Benjamin Drung <\[email protected]\fR>.
.PP
Both are released under the ISC license.
--
1.7.5.3
--- End Message ---
