Commit Graph

9 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
Vincent Laporte
87c74b8120 User manual: document duneVersion 2022-03-28 07:08:14 +02:00
Vincent Laporte
b5359c444e buildDunePackage: use dune_2 by default 2022-03-13 21:19:09 +01:00
Vincent Laporte
cea532f629 manual: document deprecated minimumOCamlVersion 2022-01-26 07:35:19 +01:00
Guillaume Girol
dbfd26724d
doc: add ocaml end user doc to nixpkgs manual (#145100)
doc: add ocaml end user doc to nixpkgs manual

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Dmitry Kalinkin <dmitry.kalinkin@gmail.com>
2021-11-16 16:49:17 +00:00
Graham Fawcett
d26902aef9
Refresh the Ocaml package examples; document useDune2 (#127520)
The current example in the manual no longer builds, mainly because
`useDune2 = true` is required, but also because the inputs have changed.
The new examples are copied verbatim from nixpkgs.
2021-06-22 18:53:27 +02:00
V
7616206b77
doc: add function argument order convention (#110060)
* doc: add function argument order convention

Ordering by usage is the de facto ordering given to arguments. It's
logical, and makes finding argument usage easier. Putting lib first is
common in NixOS modules, so it's reasonable to mirror this in nixpkgs
proper. Additionally, it's not a package as such, has zero dependencies,
and can be found used anywhere in a derivation.

* doc: clean up usage of lib
2021-01-20 19:07:16 -05: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
AndersonTorres
f5baf84be5 Convert OCaml from DocBook to CommonMark 2020-12-04 23:35:26 -03:00