From patchwork Tue Jun 4 16:11:20 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Emil Velikov via arch-projects X-Patchwork-Id: 1137 Return-Path: Delivered-To: patchwork@archlinux.org Received: from apollo.archlinux.org (localhost [127.0.0.1]) by apollo.archlinux.org (Postfix) with ESMTP id 54DF7F4121DC for ; Tue, 4 Jun 2019 16:11:41 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on apollo X-Spam-Level: X-Spam-Status: No, score=-3.4 required=5.0 tests=DKIM_SIGNED=0.1, DKIM_VALID=-0.1,DKIM_VALID_AU=-0.1,MAILING_LIST_MULTI=-1, RCVD_IN_DNSWL_MED=-2.3,SPF_HELO_NONE=0.001,T_DKIMWL_WL_HIGH=-0.01, T_DMARC_POLICY_NONE=0.01 autolearn=unavailable autolearn_force=no version=3.4.2 X-Spam-BL-Results: [127.0.9.2] Received: from orion.archlinux.org (orion.archlinux.org [IPv6:2a01:4f8:160:6087::1]) by apollo.archlinux.org (Postfix) with ESMTPS for ; Tue, 4 Jun 2019 16:11:41 +0000 (UTC) Received: from orion.archlinux.org (localhost [127.0.0.1]) by orion.archlinux.org (Postfix) with ESMTP id E86FF1314808FA; Tue, 4 Jun 2019 16:11:36 +0000 (UTC) Received: from luna.archlinux.org (luna.archlinux.org [5.9.250.164]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits)) (No client certificate requested) by orion.archlinux.org (Postfix) with ESMTPS; Tue, 4 Jun 2019 16:11:36 +0000 (UTC) Received: from luna.archlinux.org (luna.archlinux.org [127.0.0.1]) by luna.archlinux.org (Postfix) with ESMTP id CB0B92C556; Tue, 4 Jun 2019 16:11:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=archlinux.org; s=luna2; t=1559664696; bh=IU71+mytbVA6O5CVVOyXwgZM6ZLEt1CJPOZtbaQ4MpA=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc; b=loh9RQ0K1naDeZMSPZ7FsTcyvjFCdn4GwRAprRiwifqTQ9EaVWtPY04BT67X7ZssF qcO/9iLdpvTTl5vqTz5/kcBFnIomm9pmYSRSPLYyT5xmp7xsXOnn4yGjoyIpXjLzVg ymCKpVBq1W40nLtiRxCJxyU3ZGdKb2iR08+VvX1noLydLGQK238Vdz1nho8vbulXjM zHWU/9EF/1cRcB9H8iTIw2cKcqqb7x7/mqTs0n9KJ2WpS8soP29h/+qabhUKX5px6I sZjWZODd/w8IZUvc8EWZ/l2x1qysi87m1awlpEXpqtHyytAwuGyoqJNmZbPQVS3vUL nNCi9fngq0EXEkuzPIWEvMMq7fOCJB6h0BEEXSMwzwrwDEIk/VftHvSjQZuZtQWAJn JiYkwkcXKoFf625fo1cOJ1D+lh0p929x5L6zatAhIUkW0WP4badmSCPDI4AVgRbPnM otrDwghPPY4NxEGEiM3h6x0Pr7X+4LCL92OJBEekDf2RiBFnCTKzuFR5iags2ZAiRu 328PG9BQWvTYY7VozsHMUV0KJTCSEfRh+UVmJHuFvOR4fEcvjV9NubpdLGctqe3ktS NV4/cJqTxqFNN/Li9gVEAkqLaGTSsEZlEDPt3lakTNXkbVPZISQ4HWuLF+qGbD40mz zacW6UWGfv77QWagxveuch0Q= Received: from luna.archlinux.org (luna.archlinux.org [127.0.0.1]) by luna.archlinux.org (Postfix) with ESMTP id B6BC02C530 for ; Tue, 4 Jun 2019 16:11:33 +0000 (UTC) Received: from orion.archlinux.org (orion.archlinux.org [IPv6:2a01:4f8:160:6087::1]) by luna.archlinux.org (Postfix) with ESMTPS for ; Tue, 4 Jun 2019 16:11:33 +0000 (UTC) Received: from orion.archlinux.org (localhost [127.0.0.1]) by orion.archlinux.org (Postfix) with ESMTP id 638431314808F3; Tue, 4 Jun 2019 16:11:32 +0000 (UTC) Received: from didactylos.localdomain (unknown [216.97.144.2]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: eschwartz) by orion.archlinux.org (Postfix) with ESMTPSA id 8B6621314808F2; Tue, 4 Jun 2019 16:11:31 +0000 (UTC) To: arch-projects@archlinux.org Date: Tue, 4 Jun 2019 12:11:20 -0400 Message-Id: <20190604161120.4180-2-eschwartz@archlinux.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190604161120.4180-1-eschwartz@archlinux.org> References: <20190418011506.4350-1-eschwartz@archlinux.org> <20190604161120.4180-1-eschwartz@archlinux.org> MIME-Version: 1.0 Subject: [arch-projects] [devtools] [PATCH v3 2/2] doc: add manpage for the new offload-build tool X-BeenThere: arch-projects@archlinux.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Arch Linux projects development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Eli Schwartz via arch-projects Reply-To: Arch Linux projects development discussion Cc: Eli Schwartz , svenstaro@gmail.com Errors-To: arch-projects-bounces@archlinux.org Sender: "arch-projects" Signed-off-by: Eli Schwartz --- 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 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* :: + Build against a specific repository. The default is `extra`, to build packages using + the stable repositories via extra-x86_64-build. + +*-a, --arch* :: + Build against a specific architecture. The default is `x86_64`, the only + architecture officially supported by Arch Linux. + +*-s, --server* :: + 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 ` + +include::footer.asciidoc[]