From patchwork Wed Nov 23 05:28:16 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 698060 X-Patchwork-Delegate: ruscur@russell.cc Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [103.22.144.68]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3tNrWG1kJvz9t17 for ; Wed, 23 Nov 2016 16:29:46 +1100 (AEDT) Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 3tNrWG18F6zDvmw for ; Wed, 23 Nov 2016 16:29:46 +1100 (AEDT) X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 3tNrTt5QmMzDvs2 for ; Wed, 23 Nov 2016 16:28:34 +1100 (AEDT) Received: from pps.filterd (m0098409.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.17/8.16.0.17) with SMTP id uAN5PhX0075643 for ; Wed, 23 Nov 2016 00:28:32 -0500 Received: from e23smtp03.au.ibm.com (e23smtp03.au.ibm.com [202.81.31.145]) by mx0a-001b2d01.pphosted.com with ESMTP id 26w4kvhrjb-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Wed, 23 Nov 2016 00:28:32 -0500 Received: from localhost by e23smtp03.au.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 23 Nov 2016 15:28:30 +1000 Received: from d23dlp02.au.ibm.com (202.81.31.213) by e23smtp03.au.ibm.com (202.81.31.209) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Wed, 23 Nov 2016 15:28:27 +1000 Received: from d23relay10.au.ibm.com (d23relay10.au.ibm.com [9.190.26.77]) by d23dlp02.au.ibm.com (Postfix) with ESMTP id 9FCBB2BB0045 for ; Wed, 23 Nov 2016 16:28:26 +1100 (EST) Received: from d23av05.au.ibm.com (d23av05.au.ibm.com [9.190.234.119]) by d23relay10.au.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id uAN5SQEE66453624 for ; Wed, 23 Nov 2016 16:28:26 +1100 Received: from d23av05.au.ibm.com (localhost [127.0.0.1]) by d23av05.au.ibm.com (8.14.4/8.14.4/NCO v10.0 AVout) with ESMTP id uAN5SQJN001178 for ; Wed, 23 Nov 2016 16:28:26 +1100 Received: from ozlabs.au.ibm.com (ozlabs.au.ibm.com [9.192.253.14]) by d23av05.au.ibm.com (8.14.4/8.14.4/NCO v10.0 AVin) with ESMTP id uAN5SQpp001175 for ; Wed, 23 Nov 2016 16:28:26 +1100 Received: from ajd.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher AES128-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id 021E7A0080 for ; Wed, 23 Nov 2016 16:28:26 +1100 (AEDT) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org Date: Wed, 23 Nov 2016 16:28:16 +1100 X-Mailer: git-send-email 2.10.2 X-TM-AS-MML: disable X-Content-Scanned: Fidelis XPS MAILER x-cbid: 16112305-0008-0000-0000-000000E6B556 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 16112305-0009-0000-0000-0000088EAAF2 Message-Id: <20161123052816.16015-1-andrew.donnellan@au1.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:, , definitions=2016-11-23_01:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 suspectscore=1 malwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1609300000 definitions=main-1611230099 Subject: [snowpatch] [PATCH] README: document dependencies better X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" Add a section documenting non-Rust dependencies we have. This is probably incomplete, but it's a start. Also note that cargo will get all our Rust dependencies for us. Reported-by: Russell Currey Closes: #37 ("Document non-Rust dependencies") Signed-off-by: Andrew Donnellan --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0b0c1c1..86057ff 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,20 @@ it, you will need Rust and its package manager, Cargo. snowpatch should run on any target that Rust compiles on, however it has only been tested on Linux. We do not provide pre-built binaries at this stage. -snowpatch also requires the `git` binary to be installed. We try to use the -[git2-rs](https://github.com/alexcrichton/git2-rs) library where possible, -however some operations require the binary (such as applying patches). +### Non-Rust dependencies -snowpatch can be compiled with `cargo build --release`, which will make -`target/release/snowpatch`. +* [`git`](https://git-scm.com): we try to use the + [`git2-rs`](https://github.com/alexcrichton/git2-rs) library where + possible, but we still need the binary for a few operations. +* [CMake](https://cmake.org) +* [OpenSSL](https://www.openssl.org) headers +* [OpenSSH](https://www.openssh.com) headers + +### Building + +snowpatch can be compiled with `cargo build --release`, which will +download and build the Rust packages we depend on. The executable can +be found in `target/release/snowpatch`. Contributing