Document the concept of “experimental feature” #5930
Conversation
|
I would call it "experimental features" not "experimental flags" simply because I have the PR that allows making flags gated on experimental features, and I would think such flags would be called experimental flags not the experimental features themselves :). |
I'm not fond of “experimental features” because they don't have to be “features” per se ( |
|
That's a good reason; I am open to other alternatives too --- just want to avoid the flags issue. What about just "experiments"? :) |
|
experimental
Although I actually like "experiment". |
|
In additional to allowing flags to be marked experimental, I also made a PR to allow settings/options to be marked experimental :). |
fricklerhandwerk
changed the title
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-03-13-nix-team-meeting-minutes-40/26309/1 |
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
(Not everywhere because it doesn’t make sense everywhere. But in most places)
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
as discussed in the Nix team meeting 2023-03-14
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Hard to do from the suggestions window :).
And also add another punctuation-based line break.
In particular, `nix --help` is stable so we must be careful about what it mentions.
fricklerhandwerk
force-pushed
the
Experimental-flag-documentation
branch
from
7fff4c3 to
adcd7d6
Compare
|
@thufschmitt we paired with @Ericson2314 yesterday to fix this up. The change against what you and me prepared is now minimal and only makes slightly more concrete the definition of experimental features and the process. I think we can merge this as is (squash!), as the spirit has not changed since the team's approval. If that's okay I'd provide the ASCII diagram so it renders properly on the manual. @Ericson2314 wants to follow up with a "why exp features" section, a glossary entry, and more links to this page, and I'd support that with pairing or reviews. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-04-17-nix-team-meeting-minutes-49/27379/1 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-47/27387/1 |
Not sure the Nix manual is the best place to put this, but I couldn’t think of any other.
This is just one take on it, and it’s obviously open for debate