aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorJade Lovelace <lix@jade.fyi>2024-08-09 20:09:08 -0700
committerJade Lovelace <lix@jade.fyi>2024-08-09 23:22:11 -0700
commit7ca47a0e69f33026bfef1e21552301fc41cac636 (patch)
tree358d8e46f07c084753bbb6a0c8baa20ec54cc0a1 /doc/manual
parent35c9069c665fd776a377c179231403f9877e3e2f (diff)
rl-next: add extra context to a few release notes
This was found while writing the release blog post. Change-Id: Ifd55f308d4d4c831273cbe6ea35d29a38e134783
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/rl-next/better-invalid-path-errors.md10
-rw-r--r--doc/manual/rl-next/build-dir.md1
-rw-r--r--doc/manual/rl-next/sanitizers.md9
3 files changed, 17 insertions, 3 deletions
diff --git a/doc/manual/rl-next/better-invalid-path-errors.md b/doc/manual/rl-next/better-invalid-path-errors.md
new file mode 100644
index 000000000..63680a026
--- /dev/null
+++ b/doc/manual/rl-next/better-invalid-path-errors.md
@@ -0,0 +1,10 @@
+---
+synopsis: "Confusing 'invalid path' errors are now 'path does not exist'"
+cls: [1161, 1160, 1159]
+credits: midnightveil
+category: Improvements
+---
+
+Previously, if a path did not exist in a Nix store, it was referred to as the internal name "path is invalid".
+This is, however, very confusing, and there were numerous such errors that were exactly the same, making it hard to debug.
+These errors are now more specific and refer to the path not existing in the store.
diff --git a/doc/manual/rl-next/build-dir.md b/doc/manual/rl-next/build-dir.md
index 88bcd8da4..7ce9fab15 100644
--- a/doc/manual/rl-next/build-dir.md
+++ b/doc/manual/rl-next/build-dir.md
@@ -1,6 +1,7 @@
---
synopsis: "Add a `build-dir` setting to set the backing directory for builds"
cls: 1514
+prs: [gh#10303, gh#10312, gh#10883]
credits: [roberth, tomberek]
category: Improvements
---
diff --git a/doc/manual/rl-next/sanitizers.md b/doc/manual/rl-next/sanitizers.md
index 0abc57c7b..0b8e36340 100644
--- a/doc/manual/rl-next/sanitizers.md
+++ b/doc/manual/rl-next/sanitizers.md
@@ -1,10 +1,13 @@
---
synopsis: "Lix now supports building with UndefinedBehaviorSanitizer"
-cls: [1483]
+cls: [1483, 1481, 1669]
credits: [jade]
category: Development
---
-You can now build Lix with the configuration option `-Db_sanitize=undefined` and it will both work and pass tests. AddressSanitizer support is also coming soon.
+You can now build Lix with the configuration option `-Db_sanitize=undefined,address` and it will both work and pass tests with both AddressSanitizer and UndefinedBehaviorSanitizer enabled.
+To use ASan specifically, you have to set `-Dgc=disabled`, which an error message will tell you to do if necessary anyhow.
-For a list of undefined behaviour fixed by sanitizer usage, see [the gerrit topic "undefined-behaviour"](https://gerrit.lix.systems/q/topic:%22undefined-behaviour%22).
+Furthermore, tests passing with Clang ASan+UBSan is checked on every change in CI.
+
+For a list of undefined behaviour found by tooling usage, see [the gerrit topic "undefined-behaviour"](https://gerrit.lix.systems/q/topic:%22undefined-behaviour%22).