diff options
| author | Ryan Mulligan <ryan@ryantm.com> | 2021-01-01 09:45:43 -0800 |
|---|---|---|
| committer | Ryan Mulligan <ryan@ryantm.com> | 2021-01-01 10:02:57 -0800 |
| commit | b8344f9e5cd2dcd21e31d1c077393bdc7b19e860 (patch) | |
| tree | 55581aab77e702b4403624728ced282c72bf4609 /doc/builders | |
| parent | 70a061bd6c5ff08c0f540e5f06cd1e91b717ce25 (diff) | |
doc: explicit Markdown anchors for top-level headings; remove metadata
I used the existing anchors generated by Docbook, so the anchor part
should be a no-op. This could be useful depending on the
infrastructure we choose to use, and it is better to be explicit than
rely on Docbook's id generating algorithms.
I got rid of the metadata segments of the Markdown files, because they
are outdated, inaccurate, and could make people less willing to change
them without speaking with the author.
Diffstat (limited to 'doc/builders')
| -rw-r--r-- | doc/builders/packages/cataclysm-dda.section.md | 2 | ||||
| -rw-r--r-- | doc/builders/trivial-builders.chapter.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/builders/packages/cataclysm-dda.section.md b/doc/builders/packages/cataclysm-dda.section.md index ae2ee56a010e..1173fe32adae 100644 --- a/doc/builders/packages/cataclysm-dda.section.md +++ b/doc/builders/packages/cataclysm-dda.section.md @@ -1,4 +1,4 @@ -# Cataclysm: Dark Days Ahead +# Cataclysm: Dark Days Ahead {#cataclysm-dark-days-ahead} ## How to install Cataclysm DDA diff --git a/doc/builders/trivial-builders.chapter.md b/doc/builders/trivial-builders.chapter.md index c39803fbe339..32944567c053 100644 --- a/doc/builders/trivial-builders.chapter.md +++ b/doc/builders/trivial-builders.chapter.md @@ -37,7 +37,7 @@ This works just like `runCommand`. The only difference is that it also provides Variant of `runCommand` that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network roundrip and can speed up a build. -::: {.note} +::: note This sets [`allowSubstitutes` to `false`](https://nixos.org/nix/manual/#adv-attr-allowSubstitutes), so only use `runCommandLocal` if you are certain the user will always have a builder for the `system` of the derivation. This should be true for most trivial use cases (e.g. just copying some files to a different location or adding symlinks), because there the `system` is usually the same as `builtins.currentSystem`. ::: |