Skip to content

Commit 9f8df68

Browse files
committed
doc: Add more links
Mostly in the 2.30 release notes
1 parent 58e07c3 commit 9f8df68

File tree

2 files changed

+38
-17
lines changed

2 files changed

+38
-17
lines changed

doc/manual/source/release-notes/rl-2.30.md

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Backward-incompatible changes and deprecations
44

5-
- `build-dir` no longer defaults to `$TMPDIR`
5+
- [`build-dir`] no longer defaults to `$TMPDIR`
66

77
The directory in which temporary build directories are created no longer defaults
88
to `TMPDIR` or `/tmp`, to avoid builders making their directories
@@ -19,9 +19,9 @@
1919
[structured attrs]: @docroot@/language/advanced-attributes.md#adv-attr-structuredAttrs
2020
[`builtins.derivation`]: @docroot@/language/builtins.html#builtins-derivation
2121

22-
- Rename `nix profile install` to `nix profile add` [#13224](https://github.com/NixOS/nix/pull/13224)
22+
- Rename `nix profile install` to [`nix profile add`] [#13224](https://github.com/NixOS/nix/pull/13224)
2323

24-
The command `nix profile install` has been renamed to `nix profile add` (though the former is still available as an alias). This is because the verb "add" is a better antonym for the verb "remove" (i.e. `nix profile remove`). Nix also does not have install hooks or general behavior often associated with "installing".
24+
The command `nix profile install` has been renamed to [`nix profile add`] (though the former is still available as an alias). This is because the verb "add" is a better antonym for the verb "remove" (i.e. `nix profile remove`). Nix also does not have install hooks or general behavior often associated with "installing".
2525

2626
## Performance improvements
2727

@@ -33,39 +33,39 @@ This release has a number performance improvements, in particular:
3333

3434
## Features
3535

36-
- Add stack sampling evaluation profiler [#13220](https://github.com/NixOS/nix/pull/13220)
36+
- Add [stack sampling evaluation profiler] [#13220](https://github.com/NixOS/nix/pull/13220)
3737

38-
The Nix evaluator now supports [stack sampling evaluation profiling](@docroot@/advanced-topics/eval-profiler.md) via the `--eval-profiler flamegraph` setting.
38+
The Nix evaluator now supports [stack sampling evaluation profiling](@docroot@/advanced-topics/eval-profiler.md) via the [`--eval-profiler flamegraph`] setting.
3939
It outputs collapsed call stack information to the file specified by
40-
`--eval-profile-file` (`nix.profile` by default) in a format directly consumable
40+
[`--eval-profile-file`] (`nix.profile` by default) in a format directly consumable
4141
by `flamegraph.pl` and compatible tools like [speedscope](https://speedscope.app/).
42-
Sampling frequency can be configured via `--eval-profiler-frequency` (99 Hz by default).
42+
Sampling frequency can be configured via [`--eval-profiler-frequency`] (99 Hz by default).
4343

44-
Unlike the existing `--trace-function-calls`, this profiler includes the name of the function
44+
Unlike the existing [`--trace-function-calls`], this profiler includes the name of the function
4545
being called when it's available.
4646

47-
- `nix repl` prints which variables were loaded [#11406](https://github.com/NixOS/nix/pull/11406)
47+
- [`nix repl`] prints which variables were loaded [#11406](https://github.com/NixOS/nix/pull/11406)
4848

4949
Instead of `Added <n> variables` it now prints the first 10 variables that were added to the global scope.
5050

51-
- `nix flake archive`: Add `--no-check-sigs` option [#13277](https://github.com/NixOS/nix/pull/13277)
51+
- `nix flake archive`: Add [`--no-check-sigs`] option [#13277](https://github.com/NixOS/nix/pull/13277)
5252

53-
This is useful when using `nix flake archive` with the destination set to a remote store.
53+
This is useful when using [`nix flake archive`] with the destination set to a remote store.
5454

55-
- Emit warnings for IFDs with `trace-import-from-derivation` option [#13279](https://github.com/NixOS/nix/pull/13279)
55+
- Emit warnings for IFDs with [`trace-import-from-derivation`] option [#13279](https://github.com/NixOS/nix/pull/13279)
5656

57-
While we have the setting `allow-import-from-derivation` to deny import-from-derivation (IFD), sometimes users would like to observe IFDs during CI processes to gradually phase out the idiom. The new setting `trace-import-from-derivation`, when set, logs a simple warning to the console.
57+
While we have the setting [`allow-import-from-derivation`] to deny import-from-derivation (IFD), sometimes users would like to observe IFDs during CI processes to gradually phase out the idiom. The new setting `trace-import-from-derivation`, when set, logs a simple warning to the console.
5858

5959
- `json-log-path` setting [#13003](https://github.com/NixOS/nix/pull/13003)
6060

61-
New setting `json-log-path` that sends a copy of all Nix log messages (in JSON format) to a file or Unix domain socket.
61+
New setting [`json-log-path`] that sends a copy of all Nix log messages (in JSON format) to a file or Unix domain socket.
6262

6363
- Non-flake inputs now contain a `sourceInfo` attribute [#13164](https://github.com/NixOS/nix/issues/13164) [#13170](https://github.com/NixOS/nix/pull/13170)
6464

6565
Flakes have always had a `sourceInfo` attribute which describes the source of the flake.
6666
The `sourceInfo.outPath` is often identical to the flake's `outPath`. However, it can differ when the flake is located in a subdirectory of its source.
6767

68-
Non-flake inputs (i.e. inputs with `flake = false`) can also be located at some path _within_ a wider source.
68+
Non-flake inputs (i.e. inputs with [`flake = false`]) can also be located at some path _within_ a wider source.
6969
This usually happens when defining a relative path input within the same source as the parent flake, e.g. `inputs.foo.url = ./some-file.nix`.
7070
Such relative inputs will now inherit their parent's `sourceInfo`.
7171

@@ -76,13 +76,13 @@ This release has a number performance improvements, in particular:
7676

7777
## Miscellaneous changes
7878

79-
- `builtins.sort` uses PeekSort [#12623](https://github.com/NixOS/nix/pull/12623)
79+
- [`builtins.sort`] uses PeekSort [#12623](https://github.com/NixOS/nix/pull/12623)
8080

8181
Previously it used libstdc++'s `std::stable_sort()`. However, that implementation is not reliable if the user-supplied comparison function is not a strict weak ordering.
8282

8383
- Revert incomplete closure mixed download and build feature [#77](https://github.com/NixOS/nix/issues/77) [#12628](https://github.com/NixOS/nix/issues/12628) [#13176](https://github.com/NixOS/nix/pull/13176)
8484

85-
Since Nix 1.3 (299141ecbd08bae17013226dbeae71e842b4fdd7 in 2013) Nix has attempted to mix together upstream fresh builds and downstream substitutions when remote substuters contain an "incomplete closure" (have some store objects, but not the store objects they reference).
85+
Since Nix 1.3 ([commit `299141e`] in 2013) Nix has attempted to mix together upstream fresh builds and downstream substitutions when remote substuters contain an "incomplete closure" (have some store objects, but not the store objects they reference).
8686
This feature is now removed.
8787

8888
In the worst case, removing this feature could cause more building downstream, but it should not cause outright failures, since this is not happening for opaque store objects that we don't know how to build if we decide not to substitute.
@@ -132,3 +132,22 @@ This release was made possible by the following 32 contributors:
132132
- Valentin Gagarin [**(@fricklerhandwerk)**](https://github.com/fricklerhandwerk)
133133
- Vladimír Čunát [**(@vcunat)**](https://github.com/vcunat)
134134
- Wolfgang Walther [**(@wolfgangwalther)**](https://github.com/wolfgangwalther)
135+
136+
<!-- markdown links -->
137+
[stack sampling evaluation profiler]: @docroot@/advanced-topics/eval-profiler.md
138+
[`--eval-profiler`]: @docroot@/command-ref/conf-file.md#conf-eval-profiler
139+
[`--eval-profiler flamegraph`]: @docroot@/command-ref/conf-file.md#conf-eval-profiler
140+
[`--trace-function-calls`]: @docroot@/command-ref/conf-file.md#conf-trace-function-calls
141+
[`--eval-profile-file`]: @docroot@/command-ref/conf-file.md#conf-eval-profile-file
142+
[`--eval-profiler-frequency`]: @docroot@/command-ref/conf-file.md#conf-eval-profiler-frequency
143+
[`build-dir`]: @docroot@/command-ref/conf-file.md#conf-build-dir
144+
[`nix profile add`]: @docroot@/command-ref/new-cli/nix3-profile-add.md
145+
[`nix repl`]: @docroot@/command-ref/new-cli/nix3-repl.md
146+
[`nix flake archive`]: @docroot@/command-ref/new-cli/nix3-flake-archive.md
147+
[`json-log-path`]: @docroot@/command-ref/conf-file.md#conf-json-log-path
148+
[`trace-import-from-derivation`]: @docroot@/command-ref/conf-file.md#conf-trace-import-from-derivation
149+
[`allow-import-from-derivation`]: @docroot@/command-ref/conf-file.md#conf-allow-import-from-derivation
150+
[`builtins.sort`]: @docroot@/language/builtins.md#builtins-sort
151+
[`flake = false`]: @docroot@/command-ref/new-cli/nix3-flake.md?highlight=false#flake-inputs
152+
[`--no-check-sigs`]: @docroot@/command-ref/new-cli/nix3-flake-archive.md#opt-no-check-sigs
153+
[commit `299141e`]: https://github.com/NixOS/nix/commit/299141ecbd08bae17013226dbeae71e842b4fdd7

src/libexpr/include/nix/expr/eval-settings.hh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,8 @@ struct EvalSettings : Config
211211
* `flamegraph` stack sampling profiler. Outputs folded format, one line per stack (suitable for `flamegraph.pl` and compatible tools).
212212
213213
Use [`eval-profile-file`](#conf-eval-profile-file) to specify where the profile is saved.
214+
215+
See [Using the `eval-profiler`](@docroot@/advanced-topics/eval-profiler.md).
214216
)"};
215217

216218
Setting<Path> evalProfileFile{this, "nix.profile", "eval-profile-file",

0 commit comments

Comments
 (0)