aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/src/command-ref/opt-common.md11
-rw-r--r--doc/manual/src/hacking.md8
2 files changed, 15 insertions, 4 deletions
diff --git a/doc/manual/src/command-ref/opt-common.md b/doc/manual/src/command-ref/opt-common.md
index 65e72d000..9650f53f8 100644
--- a/doc/manual/src/command-ref/opt-common.md
+++ b/doc/manual/src/command-ref/opt-common.md
@@ -52,9 +52,14 @@ Most Nix commands accept the following command-line options:
This is the raw format, as outputted by nix-build.
- internal-json
- Outputs the logs in a structured manner. NOTE: the json schema
- is not guarantees to be stable between releases.
-
+ Outputs the logs in a structured manner.
+
+ > **Warning**
+ >
+ > While the schema itself is relatively stable, the format of
+ > the error-messages (namely of the `msg`-field) can change
+ > between releases.
+
- bar
Only display a progress bar during the builds.
diff --git a/doc/manual/src/hacking.md b/doc/manual/src/hacking.md
index 1aa4e6b5f..9049e42bb 100644
--- a/doc/manual/src/hacking.md
+++ b/doc/manual/src/hacking.md
@@ -14,7 +14,7 @@ To build Nix for the current operating system/architecture use
$ nix-build
```
-or if you have a flakes-enabled nix:
+or if you have a flake-enabled nix:
```console
$ nix build
@@ -52,6 +52,12 @@ To install it in `$(pwd)/inst` and test it:
nix (Nix) 2.4
```
+To run a functional test:
+
+```console
+make tests/test-name-should-auto-complete.sh.test
+```
+
If you have a flakes-enabled Nix you can replace:
```console