Where is `overrideScope'` documented?

toraritte · July 22, 2021, 12:01am

I was reading up on overlays in the wiki when I got to the Overriding a package inside a scope section, and it mentioned that “Some packages are not in the top level of nixpkgs but inside a scope” and the example started off with overrideScope'.

Tried to find more info about it but the Nixpkgs manual has only two results (regarding Emacs), this thread is about poetry2nix, and the wiki example above is regarding Xfce.

“Scope” as a term is also not explained in the Nixpgks manual but I assume that the language packages also belong to a “scope” (e.g., under Haskell, Python, Erlang) so overrideScope' can also be used for that.

Or not. Haven’t looked at the source yet, and I thought I would ask here first. Thanks!

jtojnar · August 28, 2021, 9:00pm

The only docs I am aware of is in the source comment:

github.com

NixOS/nixpkgs/blob/8e84cafcd9350ce11e3f630003b859d4c70a483a/lib/customisation.nix#L199-L207

    
      
          /* Make a set of packages with a common scope. All packages called
             with the provided `callPackage' will be evaluated with the same
             arguments. Any package in the set may depend on any other. The
             `overrideScope'` function allows subsequent modification of the package
             set in a consistent way, i.e. all packages in the set will be
             called with the overridden packages. The package sets may be
             hierarchical: the packages in the set are called with the scope
             provided by `newScope' and the set provides a `newScope' attribute
             which can form the parent scope for later package sets. */

breakds · November 8, 2022, 7:18am

You can also find examples here