Skip to content
/ rfcs Public

Comments

Rfc 46: Link platform list#113

Merged
Mic92 merged 1 commit intoNixOS:masterfrom
toonn:rfc-46-platform-list
Nov 3, 2021
Merged

Rfc 46: Link platform list#113
Mic92 merged 1 commit intoNixOS:masterfrom
toonn:rfc-46-platform-list

Conversation

@toonn
Copy link
Contributor

@toonn toonn commented Oct 29, 2021

My intention was to add a link to the official platform list. However, I didn't manage to find one in the manual, so I only have a couple typo fixes so far.

This file was referenced from the RFC #112 discussion. Is this authoritative enough to link to as the official reference?

Copy link
Member

@7c6f434c 7c6f434c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the typo fixes

@7c6f434c
Copy link
Member

About platform list: I, personally, am of the opinion that code is more trustable than words (so linking the nix file and filling in the lower tiers is a good thing). I guess some say that the Nixpkgs manual is more human-oriented though; right now among the things I procrastinate on is finding out what toolchain is not the official toochain for the manual going forward…

@piegamesde
Copy link
Member

I am in favor for tracking this in supported.nix as well. Maybe we could add a section to the nixpkgs manual that links to both the RFC 46 and the nix file.

@7c6f434c
Copy link
Member

Some sections of the NixOS manual are auto-generated; so tier definitions + autogenerated list of systems by tier + some manual text about exceptional cases could be an option.

@toonn
Copy link
Contributor Author

toonn commented Oct 29, 2021

Is there precedence for documentation being generated from nix files outside of doc/? That would avoid having to synchronize sections of the manual. Maybe it'd be slightly easier to consume if supported.nix was a thin nix shim on top of a supported.json?

Shall I go ahead and link to supported.nix from the paragraph at line 35? One issue I see with making this file the authoritative source on tiers is it doesn't include nearly all the tiers listed in this RFC.

@7c6f434c
Copy link
Member

https://nixos.org/manual/nixos/stable/options.html for one precedent.

I would expect that Nix code to convert the tier list to Markdown would not be too efficient, but would not be a problem as long as the platform list is relatively small.

I think creating a parallel PR to add more tiers to supported.nix might be a good plan.

@Mic92 Mic92 merged commit fe4b532 into NixOS:master Nov 3, 2021
@piegamesde
Copy link
Member

This PR only fixed typos and did not add the link to the platform list. Is this intentional?

@Mic92
Copy link
Member

Mic92 commented Nov 3, 2021

The list is here but not yet merged NixOS/nixpkgs#143732
I merged the typos already so it this PR does not come up in our script everytime: https://github.com/NixOS/rfc-steering-committee/blob/master/rfc-report.jq

@toonn
Copy link
Contributor Author

toonn commented Nov 3, 2021

@piegamesde, the typo fixes kinda stood on their own. I didn't really want to claim multiple RFC PR numbers. The links to the list would be added once NixOS/nixpkgs#143732 is resolved. Discussion has somewhat halted on that so I don't have a clear way forward yet. I'll bring it up in chat a couple times.

KAction pushed a commit to KAction/rfcs that referenced this pull request Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants