Skip to content

Commit dfcab80

Browse files
committed
docs: update location of TESTGROUND_HOME to xdg directory specification
See testground/testground#1544 and https://github.com/adrg/xdg
1 parent 68a6f03 commit dfcab80

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

concepts-and-architecture/builders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ None of these options are required and need only be edited if the defaults do no
6363

6464
## Examples
6565

66-
Single build for a single test for the example/output plan using the exec:go builder. This command will produce a binary which you can find in `~/testground/` on Linux and macOS systems.
66+
Single build for a single test for the example/output plan using the exec:go builder. This command will produce a binary which you can find in `~/.config/testground/` on Linux or `~/Library/Application Support/testground` on macOS systems.
6767

6868
```bash
6969
$ testground build single --plan=example --builder=exec:go --wait

getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Configure `$TESTGROUND_HOME` and copy the example `network` test plan into the `
6363

6464
```bash
6565
# assuming you already started your Testground daemon (as instructed above)
66-
# there should be a `testground` directory in your home folder, i.e. `~/testground`
66+
# there should be a `testground` directory in your home folder, i.e. `~/.config/testground` or ~/Library/Application Support/testground
6767
#
6868
# from your testground/testground Git checkout, run:
6969
$ testground plan import --from ./plans/network

writing-test-plans/quickstart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Go through the [Getting started](../getting-started.md) page and follow the inst
1414

1515
### 2. Create a test plan
1616

17-
Testground stores plans in the `$TESTGROUND_HOME` directory. This directory is created for you in your `home` directory, but if you prefer to store plans in another location, you can adjust the location using the environment variable.
17+
Testground stores plans in the `$TESTGROUND_HOME` directory. This directory is created for you in `~/.config/testground` (linux) or ` ~/Library/Application Support/testground` (mac), but if you prefer to store plans in another location, you can adjust the location using the environment variable.
1818

1919
```bash
20-
# OPTIONAL - adjust TESTGROUND_HOME, default is ~/testground
20+
# OPTIONAL - adjust TESTGROUND_HOME, default is ~/.config/testground or ~/Library/Application Support/testground on mac
2121
$ export TESTGROUND_HOME=/path/to/testground/home
2222

2323
# create your first test plan

0 commit comments

Comments
 (0)