Commit 2ecc93d6 authored by pennae's avatar pennae
Browse files

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.
parent f9ba3027

doc/builders/testers.chapter.md

+1 −1
Original line number Diff line number Diff line 
# Testers {#chap-testers}

This chapter describes several testing builders which are available in the <literal>testers</literal> namespace.

This chapter describes several testing builders which are available in the `testers` namespace.



## `hasPkgConfigModule` {#tester-hasPkgConfigModule}

doc/stdenv/meta.chapter.md

+1 −1
Original line number Diff line number Diff line
@@ -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}

doc/stdenv/stdenv.chapter.md

+4 −3
Original line number Diff line number Diff line
@@ -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.

:::