From 5e80472ba2599dbb2ec94623721f105dcdfed5ca Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Tue, 7 Apr 2020 14:05:07 +0200 Subject: Add note on tests configuration --- tests/build/root.build | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/tests/build/root.build b/tests/build/root.build index 55297f8..9d77c0d 100644 --- a/tests/build/root.build +++ b/tests/build/root.build @@ -1,13 +1,18 @@ # file : tests/build/root.build # license : MIT; see accompanying LICENSE file -# Use remote repository locations for tests. +# Use remote instead of local repository locations for tests. +# +# Note that this is an "instead of" rather than "in addition to" configuration +# so ideally you would want to run both with and without this enabled. This is +# also one of the reasons remote tests are not enabled by default (the other +# being that they take forever). # config [bool] config.bpkg.tests.remote ?= false -# Enable tests which use ssh protocol for remote git repositories. If true, it -# is assumed that the password-less ssh authentication is arranged for -# git.build2.org. +# Additionally enable tests that use ssh protocol for remote git repositories. +# If true, it is assumed that the password-less ssh authentication is arranged +# for git.build2.org. # config [bool] config.bpkg.tests.git.ssh ?= false -- cgit v1.1