lix-project/lix

Fork 31

[Nix#9622] Document the cursed advanced derivation attributes #84

New issue

Open

opened 2024-03-16 06:44:49 +00:00 by lix-bot · 1 comment

lix-bot commented

2024-03-16 06:44:49 +00:00

Member

Upstream-Issue: NixOS/nix#9622

Problem

Currently there's a pile of cursed advanced derivation attributes that aren't described on the "advanced derivation attributes" page here: https://nix.dev/manual/nix/2.19/language/advanced-attributes

That page seems to only describe the ones that weren't deemed cursed enough to start with two underscores.

Examples:

__noChroot
__darwinAllowLocalNetworking
__structuredAttrs (even if documented on a separate page we need one page listing all the weird attributes imo)

This shitpost lists some of those ones: https://hachyderm.io/@leftpaddotpy/111587644400392006

Proposal

Grep Nix for derivation attribute access and go collect them all, then write docs. Experimental ones too: just link to the experimental feature docs for it.

Checklist

checked latest Nix manual (source)
checked open documentation issues and pull requests for possible duplicates
(i tried, not immensely hard though)

Priorities

Add 👍 to issues you find important.

Upstream-Issue: https://git.lix.systems/NixOS/nix/issues/9622 ## Problem Currently there's a pile of cursed advanced derivation attributes that aren't described on the "advanced derivation attributes" page here: https://nix.dev/manual/nix/2.19/language/advanced-attributes That page seems to only describe the ones that weren't deemed cursed enough to start with two underscores. Examples: - __noChroot - __darwinAllowLocalNetworking - __structuredAttrs (even if documented on a separate page we need one page listing all the weird attributes imo)  This shitpost lists some of those ones: https://hachyderm.io/@leftpaddotpy/111587644400392006 ## Proposal Grep Nix for derivation attribute access and go collect them all, then write docs. Experimental ones too: just link to the experimental feature docs for it.  ## Checklist  - [x] checked [latest Nix manual] \([source]) - [x] checked [open documentation issues and pull requests] for possible duplicates (i tried, not immensely hard though) [latest Nix manual]: https://nixos.org/manual/nix/unstable/ [source]: https://github.com/NixOS/nix/tree/master/doc/manual/src [open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation ## Priorities Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).

lix-bot added the

imported

label 2024-03-16 06:44:49 +00:00

jade referenced this issue

2024-04-02 20:50:45 +00:00

Meta-bug: `builtins.derivation` replacement design #217

jade added the

docs

label 2024-04-14 21:26:34 +00:00

jade added this to the Docs rewrite project 2024-04-14 21:27:58 +00:00

lunaphied added the

label 2024-07-07 19:37:17 +00:00

qyriad commented

2024-07-09 23:12:10 +00:00

Owner

More magic attrs, not used in derivations themselves, but still magic in other areas of Lix:

recurseForDerivations:
- src/nix/search.cc
  Line 186 in 6e0ca02
  auto attr = cursor.maybeGetAttr(state->sRecurseForDerivations);
- src/libexpr/get-drvs.cc
  Line 383 in 6e0ca02
  Bindings::iterator j = i->value->attrs->find(state.sRecurseForDerivations);
_combineChannels:
- src/nix-env/nix-env.cc
  Line 175 in 6e0ca02
  attrs.alloc("_combineChannels").mkList(0);
- src/libexpr/get-drvs.cc
  Line 364 in 6e0ca02
  bool combineChannels = v.attrs->find(state.symbols.create("_combineChannels")) != v.attrs->end();

More magic attrs, not used in derivations themselves, but still magic in other areas of Lix: - `recurseForDerivations`: - https://git.lix.systems/lix-project/lix/src/commit/6e0ca0242579dc6114ccfc2417406372acc3004c/src/nix/search.cc#L186 - https://git.lix.systems/lix-project/lix/src/commit/6e0ca0242579dc6114ccfc2417406372acc3004c/src/libexpr/get-drvs.cc#L383 - `_combineChannels`: - https://git.lix.systems/lix-project/lix/src/commit/6e0ca0242579dc6114ccfc2417406372acc3004c/src/nix-env/nix-env.cc#L175 - https://git.lix.systems/lix-project/lix/src/commit/6e0ca0242579dc6114ccfc2417406372acc3004c/src/libexpr/get-drvs.cc#L364

No milestone

No project

No assignees

2 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: lix-project/lix#84

No description provided.

[Nix#9622] Document the *cursed* advanced derivation attributes #84

Problem

Proposal

Checklist

Priorities

[Nix#9622] Document the cursed advanced derivation attributes #84