diff options
author | pennae <github@quasiparticle.net> | 2023-06-10 18:06:27 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2023-06-10 18:17:05 +0200 |
commit | 2ecc93d6fe1be154da6ef9e268b46ec242998511 (patch) | |
tree | 870cfd82a80b7ee1387c3e877f0aba695b41e885 /doc/stdenv | |
parent | f9ba30270ef6121e3923338d21fd63291c9baf28 (diff) |
doc: normalize markdown for nixos-render-docs
pandoc recognizes `::: note` admonitions, nixos-render-docs only recognizes `::: {.note}`. surprisingly pandoc also emits the correct docbook tags for `[](#xref)`s, so we can use that too.
Diffstat (limited to 'doc/stdenv')
-rw-r--r-- | doc/stdenv/meta.chapter.md | 2 | ||||
-rw-r--r-- | doc/stdenv/stdenv.chapter.md | 7 |
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md index a21dfd0821af5..1c34fc76d0352 100644 --- a/doc/stdenv/meta.chapter.md +++ b/doc/stdenv/meta.chapter.md @@ -128,7 +128,7 @@ Prefer `passthru.tests` for tests that are introduced in nixpkgs because: * we can run `passthru.tests` independently * `installCheckPhase` adds overhead to each build -For more on how to write and run package tests, see <xref linkend="sec-package-tests"/>. +For more on how to write and run package tests, see [](#sec-package-tests). #### NixOS tests {#var-meta-tests-nixos} diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md index a923da935ced6..bb98d9ad7bb22 100644 --- a/doc/stdenv/stdenv.chapter.md +++ b/doc/stdenv/stdenv.chapter.md @@ -971,7 +971,8 @@ to `~/.gdbinit`. GDB will then be able to find debug information installed via ` The installCheck phase checks whether the package was installed correctly by running its test suite against the installed directories. The default `installCheck` calls `make installcheck`. -It is often better to add tests that are not part of the source distribution to `passthru.tests` (see <xref linkend="var-meta-tests"/>). This avoids adding overhead to every build and enables us to run them independently. +It is often better to add tests that are not part of the source distribution to `passthru.tests` (see +[](#var-meta-tests)). This avoids adding overhead to every build and enables us to run them independently. #### Variables controlling the installCheck phase {#variables-controlling-the-installcheck-phase} @@ -1234,7 +1235,7 @@ This runs the strip command on installed binaries and libraries. This removes un This setup hook patches installed scripts to add Nix store paths to their shebang interpreter as found in the build environment. The [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) line tells a Unix-like operating system which interpreter to use to execute the script's contents. -::: note +::: {.note} The [generic builder][generic-builder] populates `PATH` from inputs of the derivation. ::: @@ -1272,7 +1273,7 @@ patchShebangs --build configure Interpreter paths that point to a valid Nix store location are not changed. -::: note +::: {.note} A script file must be marked as executable, otherwise it will not be considered. ::: |