[devtools] doc: add manpage for the new offload-build tool

Message ID 20190415042943.13062-1-eschwartz@archlinux.org
State Superseded
Headers show
Series
  • [devtools] doc: add manpage for the new offload-build tool
Related show

Commit Message

Giancarlo Razzolini via arch-projects April 15, 2019, 4:29 a.m. UTC
Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
---
 Makefile                     |  1 +
 doc/offload-build.1.asciidoc | 38 ++++++++++++++++++++++++++++++++++++
 2 files changed, 39 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..555f761
--- /dev/null
+++ b/doc/offload-build.1.asciidoc
@@ -0,0 +1,38 @@ 
+offload-build(1)
+================
+
+Name
+----
+offload-build - Build a PKGBUILD on a remote server using makechrootpkg
+
+Synopsis
+--------
+sogrep [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.
+
+include::footer.asciidoc[]