aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Falbesoner <sebastian.falbesoner@gmail.com>2023-12-08 17:39:23 +0100
committerSebastian Falbesoner <sebastian.falbesoner@gmail.com>2023-12-08 18:16:27 +0100
commit878d914777a03a04ecb84217152e8b7fd73a5062 (patch)
tree13ebffd9e90e8c2d5026c1efde5983e6e5bb4b3a
parent4c65ac96f8b021c107783adce3e8afe4f8edee6e (diff)
downloadbitcoin-878d914777a03a04ecb84217152e8b7fd73a5062.tar.xz
doc: test: mention OS detection preferences in style guideline
-rw-r--r--test/functional/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/test/functional/README.md b/test/functional/README.md
index 1bd618a0c3..a4994f2e7c 100644
--- a/test/functional/README.md
+++ b/test/functional/README.md
@@ -37,6 +37,10 @@ don't have test cases for.
`set_test_params()`, `add_options()` and `setup_xxxx()` methods at the top of
the subclass, then locally-defined helper methods, then the `run_test()` method.
- Use `f'{x}'` for string formatting in preference to `'{}'.format(x)` or `'%s' % x`.
+- Use `platform.system()` for detecting the running operating system and `os.name` to
+ check whether it's a POSIX system (see also the `skip_if_platform_not_{linux,posix}`
+ methods in the `BitcoinTestFramework` class, which can be used to skip a whole test
+ depending on the platform).
#### Naming guidelines