doc/stdenv/meta.chapter.md: document meta.badPlatforms #225276
Conversation
We don't have any documentation for the `meta.badPlatforms` attribute. This commit adds documentation for it.
ghost
requested a review
from 
There was a problem hiding this comment.
Great addition. Thanks a lot! A few presentational nits, especially around adding cross-references to contextual knowledge.
Also please format markdown with one sentence per line, it's much easier to review, especially on small screens or restricted input methods. (Yes, nix.dev is the authoritative source for Nix documentation even if it doesn't have a Nix logo yet. It's the home of and maintained by the documentation team.)
| ```nix | ||
| meta.platforms = lib.platforms.all; | ||
| meta.badPlatforms = [ lib.systems.inspect.patterns.isStatic ]; | ||
| ``` |
There was a problem hiding this comment.
Ideally we'd have a complete example that we could refer to. We have to expect readers to drop into any piece of documentation with barely any contextual knowledge of Nix or Nixpkgs idioms or inner workings. While this snippet is enough if you know that it would apply in a mkDerivation call, it gets really confusing if you don't. Maybe in the example introduction we can refer and link to a full example, outlining how this snippet would fit in and which effect it would have.
This comment was marked as spam.
This comment was marked as spam.
|
Description of changes
We don't have any documentation for the
meta.badPlatformsattribute.This commit adds documentation for it.
Things done