mkSinkUndeclaredOptions

lib.options.mkSinkUndeclaredOptions

Docs pulled from | This Revision | about 3 hours ago

This option accepts arbitrary definitions, but it does not produce an option value.

This is useful for sharing a module across different module sets without having to implement similar features as long as the values of the options are not accessed.

Inputs

attrs: Attribute set whose attributes override the argument to mkOption.

Noogle detected

Aliases

lib.mkSinkUndeclaredOptions

Implementation

The following is the current implementation of this function.

mkSinkUndeclaredOptions = attrs: mkOption ({
    internal = true;
    visible = false;
    default = false;
    description = "Sink for option definitions.";
    type = mkOptionType {
      name = "sink";
      check = x: true;
      merge = loc: defs: false;
    };
    apply = x: throw "Option value is not readable because the option is not declared.";
  } // attrs);