mirror of
https://github.com/NixOS/nixpkgs
synced 2024-10-19 03:47:13 -04:00
98faa0c8f3
Nobody seems to have noticed this (except @Profpatsch) that options with
a "package" type do not get included in the manual.
So debugging this was a bit more involving because while generating the
manual there is an optionList' attribute built from the collected
attributes of all the option declarations.
Up to that point everything is fine except if it comes to
builtins.toXML, where attributes with { type = "derivation" } won't get
included, for example see here:
nix-repl> builtins.toXML { type = "derivation"; foo = "bar"; }
"<?xml version='1.0' encoding='utf-8'?>\n<expr>\n <derivation>
<repeated />\n </derivation>\n</expr>\n"
nix-repl> builtins.toXML { type = "somethingelse"; foo = "bar"; }
"<?xml version='1.0' encoding='utf-8'?>\n<expr>\n <attrs>
<attr name=\"foo\">\n <string value=\"bar\" />\n </attr>
<attr name=\"type\">\n <string value=\"somethingelse\" />
</attr>\n </attrs>\n</expr>\n"
The following function in libexpr/eval.cc (Nix) is responsible for toXML
dropping the attributes:
bool EvalState::isDerivation(Value & v)
{
if (v.type != tAttrs) return false;
Bindings::iterator i = v.attrs->find(sType);
if (i == v.attrs->end()) return false;
forceValue(*i->value);
if (i->value->type != tString) return false;
return strcmp(i->value->string.s, "derivation") == 0;
}
So I've renamed this now to "package" which is not only more consistent
with the option type but also shouldn't cause similar issues anymore.
Tested this on base of
|
||
|---|---|---|
| .. | ||
| tests | ||
| attrsets.nix | ||
| composable-derivation.nix | ||
| customisation.nix | ||
| debug.nix | ||
| default.nix | ||
| deprecated.nix | ||
| licenses.nix | ||
| lists.nix | ||
| maintainers.nix | ||
| meta.nix | ||
| minver.nix | ||
| modules.nix | ||
| options.nix | ||
| platforms.nix | ||
| sandbox.nix | ||
| sources.nix | ||
| strings-with-deps.nix | ||
| strings.nix | ||
| systems.nix | ||
| tests.nix | ||
| trivial.nix | ||
| types.nix | ||