Skip to content

Commit a5d186b

Browse files
committed
fix: nix/doc, remove dead links
mkdocs do not support linking to source files living outside of the doc repository. Replacing these dead links with quoted paths.
1 parent 593839c commit a5d186b

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

nix/docs/adding-tests.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ There are basically two types of tests you can add:
55
- Migration tests.
66

77
In all cases, a number of extensions may be installed into the database for
8-
use; you can see those in both [postgresql.conf.in](../tests/postgresql.conf.in)
9-
and [prime.sql](../tests/prime.sql) (extensions may be enabled in either place.)
8+
use; you can see those in both `/nix/tests/postgresql.conf.in`
9+
and `/nix/tests/prime.sql` (extensions may be enabled in either place.)
1010

1111
## pg\_regress tests
1212

13-
pg\_regress tests are in [tests/sql](./../tests/sql/) with output in [tests/expected](./../tests/expected/).
14-
To create a new test, create a new SQL file in [tests/sql](./../tests/sql/)
13+
pg\_regress tests are in `/nix/tests/sql/` with output in `/nix/tests/expected/`.
14+
To create a new test, create a new SQL file in `/nix/tests/sql/`.
1515

1616
Next, for each current major version of postgres, we run a "flake check" build one at a time.
1717

@@ -29,8 +29,8 @@ Next, review the logs to identify where the test output was written
2929

3030
```
3131
postgres> CREATE EXTENSION IF NOT EXISTS index_advisor;
32-
postgres> CREATE EXTENSION
33-
postgres> (using postmaster on localhost, port 5432)
32+
postgres> CREATE EXTENSION
33+
postgres> (using postmaster on localhost, port 5432)
3434
postgres> ============== running regression test queries ==============
3535
postgres> test new_test ... diff: /nix/store/5gk419ddz7mzzwhc9j6yj5i8lkw67pdl-tests/expected/new_test.out: No such file or directory
3636
postgres> diff command failed with status 512: diff "/nix/store/5gk419ddz7mzzwhc9j6yj5i8lkw67pdl-tests/expected/new_test.out" "/nix/store/2fbrvnnr7iz6yigyf0rb0vxnyqvrgxzp-postgres-15.6-check-harness/regression_output/results/new_test.out" > "/nix/store/2fbrvnnr7iz6yigyf0rb0vxnyqvrgxzp-postgres-15.6-check-harness/regression_output/results/new_test.out.diff
@@ -44,15 +44,15 @@ cp -r /nix/store/2fbrvnnr7iz6yigyf0rb0vxnyqvrgxzp-postgres-15.6-check-harness/re
4444

4545
Then you can review the contents of `regression_output/results/new_test.out` to see if it matches what you expected.
4646

47-
If it does match your expectations, copy the file to [tests/expected](./../tests/expected/) and the test will pass on the next run.
47+
If it does match your expectations, copy the file to `/nix/tests/expected/` and the test will pass on the next run.
4848

4949
If the output does not match your expectations, update the `<new_test>.sql` file, re-run with `nix flake check -L` and try again
5050

5151

5252
## pgTAP tests
5353

5454
These are super easy: simply add `.sql` files to the
55-
[tests/smoke](./../tests/smoke/) directory, then:
55+
`/nix/tests/smoke/` directory, then:
5656

5757
```
5858
nix flake check -L
@@ -100,7 +100,7 @@ extension authors), step 3 isn't guaranteed, so that's what the whole idea is
100100
designed to test.
101101

102102
To add data into the database, modify the
103-
[data.sql](../nix/tests/migrations/data.sql) script and add whatever you want into
103+
`/nix/tests/migrations/data.sql` script and add whatever you want into
104104
it. This script gets loaded into the old version of the database at startup, and
105105
it's expected that the new version of the database can handle it.
106106

nix/docs/nix-overlays.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Overlays are a feature of Nixpkgs that allow you to:
88
disabled-by-default feature.
99

1010
First, you need to define a file for the overlay under
11-
[overlays/](../overlays/), and then import it in `nix/overlays/default.nix`. There is an
11+
`/nix/overlays/`, and then import it in `nix/overlays/default.nix`. There is an
1212
example pull request in
1313
[#14](https://github.com/supabase/nix-postgres/issues/14) for this; an overlay
1414
typically looks like this:

0 commit comments

Comments
 (0)