From 2ecc93d6fe1be154da6ef9e268b46ec242998511 Mon Sep 17 00:00:00 2001 From: pennae Date: Sat, 10 Jun 2023 18:06:27 +0200 Subject: 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. --- doc/builders/testers.chapter.md | 2 +- doc/stdenv/meta.chapter.md | 2 +- doc/stdenv/stdenv.chapter.md | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/builders/testers.chapter.md b/doc/builders/testers.chapter.md index 928a57673e7..fb6a28b7ee4 100644 --- a/doc/builders/testers.chapter.md +++ b/doc/builders/testers.chapter.md @@ -1,5 +1,5 @@ # Testers {#chap-testers} -This chapter describes several testing builders which are available in the testers namespace. +This chapter describes several testing builders which are available in the `testers` namespace. ## `hasPkgConfigModule` {#tester-hasPkgConfigModule} diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md index a21dfd0821a..1c34fc76d03 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 . +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 a923da935ce..bb98d9ad7bb 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 ). 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. ::: -- cgit 1.4.1