nixpkgs mirror (for testing) github.com/NixOS/nixpkgs
nix

doc: minimal documentation of supported platforms

This commit adds minimal documentation of the supported platforms.
More exhaustive documentation would require producing a list of
platforms for each of the 7 tiers. This was attempted in #245368, but it
quickly became clear that that would be a long-term effort.

In the meantime, this commit adds the most important information to the
manual.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>

+19
+1
doc/using-nixpkgs.md
··· 1 1 # Using Nixpkgs {#part-using} 2 2 3 3 ```{=include=} chapters 4 + using/platform-support.chapter.md 4 5 using/configuration.chapter.md 5 6 using/overlays.chapter.md 6 7 using/overrides.chapter.md
+18
doc/using/platform-support.chapter.md
··· 1 + # Platform Support {#chap-platform-support} 2 + 3 + Packages receive varying degrees of support, both in terms of maintainer attention and available computation resources for continuous integration (CI). 4 + 5 + Below is the list of the best supported platforms: 6 + 7 + - `x86_64-linux`: Highest level of support. 8 + - `aarch64-linux`: Well supported, with most packages building successfully in CI. 9 + - `aarch64-darwin`: Receives better support than `x86_64-darwin`. 10 + - `x86_64-darwin`: Receives some support. 11 + 12 + There are many other platforms with varying levels of support. 13 + The provisional platform list in [Appendix A] of [RFC046], while not up to date, can be used as guidance. 14 + 15 + A more formal definition of the platform support tiers is provided in [RFC046], but has not been fully implemented yet. 16 + 17 + [RFC046]: https://github.com/NixOS/rfcs/blob/master/rfcs/0046-platform-support-tiers.md 18 + [Appendix A]: https://github.com/NixOS/rfcs/blob/master/rfcs/0046-platform-support-tiers.md#appendix-a-non-normative-description-of-platforms-in-november-2019