[devscripts] 01/01: debrepro: convert mapage to POD

Sat Oct 22 21:54:29 UTC 2016

This is an automated email from the git hooks/post-receive script.

terceiro pushed a commit to branch master
in repository devscripts.

commit 5d3eaabaad7c7e60db4742e67b81dbe668d19059
Author: Antonio Terceiro <terceiro at debian.org>
Date:   Sat Oct 22 10:46:08 2016 -0200

    debrepro: convert mapage to POD
---
 debian/changelog          |  1 +
 po4a/devscripts-po4a.conf |  4 +-
 scripts/Makefile          |  2 +-
 scripts/debrepro.1        | 68 ---------------------------------
 scripts/debrepro.pod      | 97 +++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 101 insertions(+), 71 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index ea65c78..f3c4870 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -16,6 +16,7 @@ devscripts (2.16.9) UNRELEASED; urgency=medium
       https://wiki.debian.org/ReproducibleBuilds/History (section "Giving up
       on build paths") for an explanation on why it is not currently feasible
       to vary build paths for reproducible builds.
+    + convert mapage to POD
 
   [ Guillem Jover ]
   * debrepro improvements (Closes: #841149):
diff --git a/po4a/devscripts-po4a.conf b/po4a/devscripts-po4a.conf
index 2d25941..7061e06 100644
--- a/po4a/devscripts-po4a.conf
+++ b/po4a/devscripts-po4a.conf
@@ -46,8 +46,8 @@
 	$lang:$lang/debi.$lang.1 add_$lang:?add_$lang/translator_man.add
 [type:man] ../scripts/debpkg.1 \
 	$lang:$lang/debpkg.$lang.1 add_$lang:?add_$lang/translator_man.add
-[type:man] ../scripts/debrepro.1 \
-	$lang:$lang/debrepro.$lang.1 add_$lang:?add_$lang/translator_man.add
+[type:pod] ../scripts/debrepro.pod \
+	$lang:$lang/debrepro.$lang.pod add_$lang:?add_$lang/translator_pod.add
 [type:man] ../scripts/debrelease.1 \
 	$lang:$lang/debrelease.$lang.1 add_$lang:?add_$lang/translator_man.add
 [type:docbook] ../scripts/deb-reversion.dbk \
diff --git a/scripts/Makefile b/scripts/Makefile
index 41094bd..931143a 100644
--- a/scripts/Makefile
+++ b/scripts/Makefile
@@ -25,7 +25,7 @@ COMPL_DIR := $(shell pkg-config --variable=completionsdir bash-completion)
 PKGNAMES:=wnpp-alert wnpp-check mk-build-deps rmadison mass-bug debsnap dd-list build-rdeps who-uploads transition-check getbuildlog dcontrol grep-excuses rc-alert whodepends dget pts-subscribe pts-unsubscribe debcheckout
 PYTHON3_SCRIPTS:=sadt suspicious-source wrap-and-sort
 
-GEN_MAN1S += devscripts.1 mk-origtargz.1 uscan.1
+GEN_MAN1S += debrepro.1 devscripts.1 mk-origtargz.1 uscan.1
 
 all: $(SCRIPTS) $(GEN_MAN1S) $(CWRAPPERS) $(COMPLETION)
 
diff --git a/scripts/debrepro.1 b/scripts/debrepro.1
deleted file mode 100644
index f637d97..0000000
--- a/scripts/debrepro.1
+++ /dev/null
@@ -1,68 +0,0 @@
-.TH DEBREPRO 1 "Debian Utilities" "DEBIAN" \" -*- nroff -*-
-.SH NAME
-debrepro \- reproduciblity tester for Debian packages
-.SH SYNOPSIS
-\fBdebrepro\fR [\fISOURCEDIR\fR]
-.SH DESCRIPTION
-\fBdebrepro\fR will build a given source directory twice, with a set of
-variation between the first and second build, and compare the binary packages
-produced. If \fBdiffoscope\fR is installed, it is used to compare non-matching
-binaries. If \fBdisorderfs\fR is installed, it is used during the build to
-inject non-determinism in filesystem listing operations.
-.PP
-\fISOURCEDIR\fR must be a directory containing an unpacked Debian source
-package. If \fISOURCEDIR\fR is omitted, the current directory is assumed.
-.SH OUTPUT DIRECTORY
-At the very end of a build, \fBdebrepro\fR will inform the location of the
-output directory where the build artifacts can be found. The contents of this
-directory is as follows:
-.TP
-.BR \fI«outdir»/first\fR
-contains the results of the first build, including a copy of the source tree,
-and the resulting binary packages.
-.TP
-.BR \fI«outdir»/first/build.sh\fR
-contains the exact build script that was used in the first build.
-.TP
-.BR \fI«outdir»/second\fR
-contains the results of the second build, including a copy of the source tree,
-and the resulting binary packages.
-.TP
-.BR \fI«outdir»/second/build.sh\fR
-contains the exact build script that was used in the second build.
-.PP
-diff'ing \fI«outdir»/first/build.sh\fR and \fI«outdir»/second/build.sh\fR is an
-excellent way of figuring out exactly what changed between the two builds.
-.SH SUPPORTED VARIATIONS
-.TP
-.BR \fBUSER\fR
-The \fI$USER\fR environment name will contain different values between the
-first and second builds.
-.TP
-.BR \fBPATH\fR
-During the second build, a fake, unexisting directory will be appended to the
-\fI$PATH\fR environment variable.
-.TP
-.BR \fBumask\fR
-The builds will use different umask settings.
-.TP
-.BR \fBlocale\fR
-Both \fI$LC_ALL\fR and \fI$LANG\fR will be different across the two builds.
-.TP
-.BR \fBtimezone\fR
-\fI$TZ\fR will be different across builds.
-.TP
-.BR \fBfilesystem\ ordering\fR
-If \fBdisorderfs\fR is installed, both builds will be done under a disorderfs
-overlay directory. This will cause filesystem listing operations to be return
-items in a non-deterministic order.
-.TP
-.BR \fBtime\fR
-The second build will be executed 213 days, 7 hours and 13 minutes in the
-future with regards to the current time.
-.BR
-.SH "SEE ALSO"
-.BR diffoscope (1),
-.BR disorderfs (1),
-.SH AUTHOR
-Antonio Terceiro <terceiro at debian.org>.
diff --git a/scripts/debrepro.pod b/scripts/debrepro.pod
new file mode 100644
index 0000000..d690a58
--- /dev/null
+++ b/scripts/debrepro.pod
@@ -0,0 +1,97 @@
+=head1 NAME
+
+debrepro - reproduciblity tester for Debian packages
+
+=head1 SYNOPSIS
+
+B<debrepro> [I<SOURCEDIR>]
+
+=head1  DESCRIPTION
+
+B<debrepro> will build a given source directory twice, with a set of
+variation between the first and the second build, and compare the binary
+packages produced. If B<diffoscope> is installed, it is used to compare
+non-matching binaries. If B<disorderfs> is installed, it is used during
+the build to inject non-determinism in filesystem listing operations.
+
+I<SOURCEDIR> must be a directory containing an unpacked Debian source
+package. If I<SOURCEDIR> is omitted, the current directory is assumed.
+
+=head1 OUTPUT DIRECTORY
+
+At the very end of a build, B<debrepro> will inform the location of the
+output directory where the build artifacts can be found. The contents of
+this directory are as follows:
+
+=over
+
+=item I<$OUTPUTDIR/first>
+
+contains the results of the first build, including a copy of the source
+tree, and the resulting binary packages.
+
+=item I<$OUTPUTDIR/first/build.sh>
+
+contains the exact build script that was used in the first build.
+
+=item I<$OUTPUTDIR/second>
+
+contains the results of the second build, including a copy of the source tree,
+and the resulting binary packages.
+
+=item I<$OUTPUTDIR/second/build.sh>
+
+contains the exact build script that was used in the second build.
+
+=back
+
+Taking a B<diff(1)> between I<$OUTPUTDIR/first/build.sh> and
+I<$OUTPUTDIR/second/build.sh> is an excellent way of figuring out
+exactly what changed between the two builds.
+
+=head1 SUPPORTED VARIATIONS
+
+=over
+
+=item B<USER>
+
+The I<$USER> environment variable will contain different values between the
+first and second builds.
+
+=item B<PATH>
+
+During the second build, a fake, unexisting directory will be appended to the
+I<$PATH> environment variable.
+
+=item B<umask>
+
+The builds will use different umask settings.
+
+=item B<locale>
+
+Both I<$LC_ALL> and I<$LANG> will be different across the two builds.
+
+=item B<timezone>
+
+I<$TZ> will be different across builds.
+
+=item filesystem ordering
+
+If B<disorderfs> is installed, both builds will be done under a disorderfs
+overlay directory. This will cause filesystem listing operations to be return
+items in a non-deterministic order.
+
+=item B<time>
+
+The second build will be executed 213 days, 7 hours and 13 minutes in the
+future with regards to the current time.
+
+=back
+
+=head1 SEE ALSO
+
+diffoscope (1), disorderfs (1),
+
+=head1  AUTHOR
+
+Antonio Terceiro <terceiro at debian.org>.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/collab-maint/devscripts.git

