pyrox.dev / nixpkgs
lol
fork atom

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.

pennae 2ecc93d6 f9ba3027

+6 -5
unified split
+1 -1
doc/builders/testers.chapter.md
··· 1 # Testers {#chap-testers} 2 - This chapter describes several testing builders which are available in the <literal>testers</literal> namespace. 3 4 ## `hasPkgConfigModule` {#tester-hasPkgConfigModule} 5
··· 1 # Testers {#chap-testers} 2 + This chapter describes several testing builders which are available in the `testers` namespace. 3 4 ## `hasPkgConfigModule` {#tester-hasPkgConfigModule} 5
+1 -1
doc/stdenv/meta.chapter.md
··· 128 * we can run `passthru.tests` independently 129 * `installCheckPhase` adds overhead to each build 130 131 - For more on how to write and run package tests, see <xref linkend="sec-package-tests"/>. 132 133 #### NixOS tests {#var-meta-tests-nixos} 134
··· 128 * we can run `passthru.tests` independently 129 * `installCheckPhase` adds overhead to each build 130 131 + For more on how to write and run package tests, see [](#sec-package-tests). 132 133 #### NixOS tests {#var-meta-tests-nixos} 134
+4 -3
doc/stdenv/stdenv.chapter.md
··· 971 972 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`. 973 974 - 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. 975 976 #### Variables controlling the installCheck phase {#variables-controlling-the-installcheck-phase} 977 ··· 1234 1235 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. 1236 1237 - ::: note 1238 The [generic builder][generic-builder] populates `PATH` from inputs of the derivation. 1239 ::: 1240 ··· 1272 1273 Interpreter paths that point to a valid Nix store location are not changed. 1274 1275 - ::: note 1276 A script file must be marked as executable, otherwise it will not be 1277 considered. 1278 :::
··· 971 972 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`. 973 974 + It is often better to add tests that are not part of the source distribution to `passthru.tests` (see 975 + [](#var-meta-tests)). This avoids adding overhead to every build and enables us to run them independently. 976 977 #### Variables controlling the installCheck phase {#variables-controlling-the-installcheck-phase} 978 ··· 1235 1236 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. 1237 1238 + ::: {.note} 1239 The [generic builder][generic-builder] populates `PATH` from inputs of the derivation. 1240 ::: 1241 ··· 1273 1274 Interpreter paths that point to a valid Nix store location are not changed. 1275 1276 + ::: {.note} 1277 A script file must be marked as executable, otherwise it will not be 1278 considered. 1279 :::