[devtools,3/3] doc: add manpage for the new makerepropkg tool

Message ID 20191118023243.339374-4-eschwartz@archlinux.org
State Accepted, archived
Headers show
Series New tool, | expand

Commit Message

Emil Velikov via arch-projects Nov. 18, 2019, 2:32 a.m. UTC
Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
---
 Makefile                    |  1 +
 doc/makerepropkg.1.asciidoc | 38 +++++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 doc/makerepropkg.1.asciidoc

Patch

diff --git a/Makefile b/Makefile
index 090063d..4ca7155 100644
--- a/Makefile
+++ b/Makefile
@@ -72,6 +72,7 @@  MANS = \
 	doc/checkpkg.1 \
 	doc/offload-build.1 \
 	doc/sogrep.1 \
+	doc/makerepropkg.1 \
 	doc/mkarchroot.1 \
 	doc/find-libdeps.1 \
 	doc/find-libprovides.1
diff --git a/doc/makerepropkg.1.asciidoc b/doc/makerepropkg.1.asciidoc
new file mode 100644
index 0000000..7d68e5e
--- /dev/null
+++ b/doc/makerepropkg.1.asciidoc
@@ -0,0 +1,38 @@ 
+makerepropkg(1)
+================
+
+Name
+----
+makerepropkg - Rebuild a package to see if it is reproducible
+
+Synopsis
+--------
+makerepropkg [OPTIONS] <package_file>
+
+Description
+-----------
+
+Given the path to a built pacman package, attempt to rebuild it using the
+PKGBUILD in the current directory. The package will be built in an environment
+as closely matching the environment of the initial package as possible, by
+building up a chroot to match the information exposed in the package's
+linkman:BUILDINFO[5] manifest. On success, the resulting package will be
+compared to the input package, and makerepropkg will report whether the
+artifacts are identical.
+
+This implements a verifier for pacman/libalpm packages in accordance with the
+link:https://reproducible-builds.org/[Reproducible Builds] project.
+
+Options
+-------
+
+*-c*::
+	Set the pacman cache directory.
+
+*-M* <file>::
+	Location of a makepkg config file.
+
+*-h*::
+	Show this usage message
+
+include::footer.asciidoc[]