[devtools,v3,2/2] doc: add manpage for the new offload-build tool

Message ID 20190604161120.4180-2-eschwartz@archlinux.org
State Accepted
Headers show
Series
  • [devtools,v2] Add new tool: offload-build
Related show

Commit Message

Eli Schwartz via arch-projects June 4, 2019, 4:11 p.m. UTC
Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
---

v3: update manpage for new v3 parameters.

 Makefile                     |  1 +
 doc/offload-build.1.asciidoc | 52 ++++++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+)
 create mode 100644 doc/offload-build.1.asciidoc

Patch

diff --git a/Makefile b/Makefile
index 2306a17..27cd90f 100644
--- a/Makefile
+++ b/Makefile
@@ -69,6 +69,7 @@  BASHCOMPLETION_LINKS = \
 MANS = \
 	doc/lddd.1 \
 	doc/checkpkg.1 \
+	doc/offload-build.1 \
 	doc/sogrep.1 \
 	doc/mkarchroot.1 \
 	doc/find-libdeps.1 \
diff --git a/doc/offload-build.1.asciidoc b/doc/offload-build.1.asciidoc
new file mode 100644
index 0000000..3633faa
--- /dev/null
+++ b/doc/offload-build.1.asciidoc
@@ -0,0 +1,52 @@ 
+offload-build(1)
+================
+
+Name
+----
+offload-build - Build a PKGBUILD on a remote server using makechrootpkg
+
+Synopsis
+--------
+offload-build [OPTIONS] -- [ARCHBUILD_OPTIONS]
+
+Description
+-----------
+
+Build a PKGBUILD on a remote server using makechrootpkg. Requires a remote user
+that can run archbuild in a non-interactive manner, e.g. must be able to
+elevate permissions using passwordless sudo.
+
+Options
+-------
+
+*-r, --repo* <reponame>::
+	Build against a specific repository. The default is `extra`, to build packages using
+	the stable repositories via extra-x86_64-build.
+
+*-a, --arch* <architecture>::
+	Build against a specific architecture. The default is `x86_64`, the only
+	architecture officially supported by Arch Linux.
+
+*-s, --server* <hostname>::
+	Offload to a specific build server. The default is dragon.archlinux.org
+	which is used as part of the build toolchain for the official Arch Linux
+	repos.
+
+*-h, --help*::
+	Show a help text.
+
+Passing options to archbuild
+----------------------------
+
+Options after a delimiting -- are passed on to archbuild on the remote.
+archbuild in turn supports passing arguments on to makechrootpkg, which in turn
+supports passing options to makepkg. Since each uses -- to delimit options that
+are forwarded, make sure to escape them properly:
+
+	`offload-build offload-args -- archbuild-args -- makechrootpkg-args -- makepkg-args`
+
+Example: To use a second `testing-x86_64-build` instance with another copydir:
+
+	`offload-build -r testing -- -- -l <chroot_copy>`
+
+include::footer.asciidoc[]