Commit Graph

13 Commits

Author SHA1 Message Date
Colin Arnott
bac379f30a
doc: use sri hash syntax
The nixpkgs manual contains references to both sri hash and explicit
sha256 attributes. This is at best confusing to new users. Since the
final destination is exclusive use of sri hashes, see nixos/rfcs#131,
might as well push new users in that direction gently.

Notable exceptions to sri hash support are builtins.fetchTarball,
cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and
fetchCrate. None, other than builtins.fetchTarball, are fundamentally
incompatible, but all currently accept explicit sha256 attributes as
input. Because adding backwards compatibility is out of scope for this
change, they have been left intact, but migration to sri format has been
made for any using old hash formats.

All hashes have been manually tested to be accurate, and updates were
only made for missing upstream artefacts or bugs.
2022-12-04 06:12:18 +00:00
Emilia Bopp
8bec7996cc doc: fix syntax error in Lua documentation 2022-10-25 22:34:32 +02:00
Amon Stopinšek
5f2db22eae doc: fix broken links
Links in documentation shouldn't point to dead ends.
2021-12-09 18:57:38 +00:00
Matthieu Coudron
fa1dedee47 doc: updated lua doc
mentions lua 5.4 + fixed an error
2021-08-09 21:37:58 +02:00
Jan Tojnar
6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Florian Engel
3329093c6a Remove repeating words from doc 2021-03-14 12:15:34 +01:00
Profpatsch
b0c1583a0b doc: stdenv.lib -> lib
Part of: https://github.com/NixOS/nixpkgs/issues/108938

Changing the documentation to not refer to stdenv.lib is the first
step to make people use it directly.
2021-01-11 09:52:27 +01:00
Ryan Mulligan
b8344f9e5c 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.
2021-01-01 10:02:57 -08:00
Matthieu Coudron
8d05c66dc6 fixup! update 2020-06-07 20:12:56 +02:00
Matthieu Coudron
3042b38ce1 update 2020-06-06 20:20:27 +02:00
Matthieu Coudron
2909dc9f39 builds 2020-06-06 17:33:41 +02:00
Matthieu Coudron
404d057e89 Added an example about overlay 2020-06-06 17:33:39 +02:00
Matthieu Coudron
5cfcfc300b doc: update lua documentation
Reflects the recent changes to the lua infrastructure.
Packaging from luarocks should be encouraged.
2020-06-06 17:33:37 +02:00