commit d469c4c2197aa2d8914b98e96dbeb8b5e00f87e1
from: Stefan Sperling <stsp@stsp.name>
date: Fri Jan  3 13:58:23 2025 UTC

add more info about the test suite to README.portable

Prompted by questions from Johannes Kastl.

commit - ed4ebda33a8420b42a4a277ba056d2594ab4f2e9
commit + d469c4c2197aa2d8914b98e96dbeb8b5e00f87e1
blob - 68926998bd2db00bc8eb0b4f1c987174e4119875
blob + 364ce43262d8d96b56947eb489c39d5d7d8bf7b7
--- README.portable
+++ README.portable
@@ -72,7 +72,33 @@ To run the test suite:
 ```
  $ make tests
 ```
+
+The tests depend on git and the HTTP::Daemon Perl module.
+
+Got may have to be installed system-wide before the tests will run
+successfully because paths to helper programs, such as got-read-pack,
+are hard-coded in user-facing binaries, such as got and tog.
+
+Operations such as clone and send which use the network will be trying to
+connect to 127.0.0.1 over ssh, as the same user who invoked 'make tests'.
+The command 'ssh 127.0.0.1' must succeed without any interactive prompting.
+The host key may need to be manually accepted once before running tests.
+An SSH key can be installed in ~/.ssh/authorized_keys for authentication.
+
+The OpenBSD version of Got also has tests for gotd and gotwebd.
+These tests cannot be run in -portable yet.
 
+There are environment variables which control some test parameters:
+
+GOT_TEST_PACK=1 will force tests to use pack files instead of loose
+objects. GOT_TEST_PACK=ref-delta will force use of pack files with
+ref-deltas rather than offset-deltas.
+
+GOT_TEST_ALGO=sha256 will run tests with sha256 repositories.
+
+GOT_TEST_ROOT can be set to a path where temporary test data gets stored.
+This defaults to /tmp.
+
 Dependencies
 ============