diff options
| author | Lorenzo Manacorda <lorenzo@mailbox.org> | 2023-07-25 13:40:09 +0200 |
|---|---|---|
| committer | Lorenzo Manacorda <lorenzo@mailbox.org> | 2023-10-02 21:21:56 +0200 |
| commit | b19e9bebdc8ee7dce5a4c40e510165f0011008b7 (patch) | |
| tree | 0d282a09439dd11d0497f555826a71ef1858f06b /doc | |
| parent | 4a359e2106bc1eb23d9c99837e8f1ecb90453f3e (diff) | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/using-nixpkgs.md | 1 | ||||
| -rw-r--r-- | doc/using/platform-support.chapter.md | 18 |
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/using-nixpkgs.md b/doc/using-nixpkgs.md index bb222ae384fa6..f850b2e83c28d 100644 --- a/doc/using-nixpkgs.md +++ b/doc/using-nixpkgs.md @@ -1,6 +1,7 @@ # Using Nixpkgs {#part-using} ```{=include=} chapters +using/platform-support.chapter.md using/configuration.chapter.md using/overlays.chapter.md using/overrides.chapter.md diff --git a/doc/using/platform-support.chapter.md b/doc/using/platform-support.chapter.md new file mode 100644 index 0000000000000..3f91b3d5d9808 --- /dev/null +++ b/doc/using/platform-support.chapter.md @@ -0,0 +1,18 @@ +# Platform Support {#chap-platform-support} + +Packages receive varying degrees of support, both in terms of maintainer attention and available computation resources for continuous integration (CI). + +Below is the list of the best supported platforms: + +- `x86_64-linux`: Highest level of support. +- `aarch64-linux`: Well supported, with most packages building successfully in CI. +- `aarch64-darwin`: Receives better support than `x86_64-darwin`. +- `x86_64-darwin`: Receives some support. + +There are many other platforms with varying levels of support. +The provisional platform list in [Appendix A] of [RFC046], while not up to date, can be used as guidance. + +A more formal definition of the platform support tiers is provided in [RFC046], but has not been fully implemented yet. + +[RFC046]: https://github.com/NixOS/rfcs/blob/master/rfcs/0046-platform-support-tiers.md +[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 |