nixpkgs/lib
Silvan Mosberger ed5e926ec4
Merge pull request #268619 from tweag/lib-descriptions
lib: Take advantage of section descriptions
2023-11-20 17:25:59 +01:00
..
fileset lib.fileset: Re-order to match reference overview 2023-11-19 23:52:13 +01:00
path lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
systems lib.systems: elaborate Rust metadata 2023-11-09 10:02:24 +01:00
tests Merge pull request #266443 from amjoseph-nixpkgs/pr/lib-tests-no-aws-sdk 2023-11-19 06:17:18 +01:00
ascii-table.nix strings: add escapeQuery for url encoding 2023-03-03 20:48:55 +01:00
asserts.nix lib: add asserts.assertEachOneOf 2023-11-09 17:27:20 +01:00
attrsets.nix lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
cli.nix
customisation.nix lib.makeOverridable: simplify function arguments preservation 2023-11-07 01:58:48 +00:00
debug.nix lib/debug: remove unused let bindings 2023-06-23 09:41:04 +00:00
default.nix Merge pull request #239722 from Stunkymonkey/lib-allUnique 2023-11-15 04:37:39 +01:00
deprecated.nix lib.closePropagation: Remove the quadratic behavior in lib.closePropagation 2022-10-07 18:03:42 +02:00
derivations.nix lib.derivations: fix comment typo 2023-06-02 23:57:30 +08:00
fetchers.nix
filesystem.nix lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
fixed-points.nix lib/fixed-points.nix: correct typo 2023-10-31 11:45:51 -07:00
flake.nix Fix import path. 2021-08-14 14:46:00 -05:00
generators.nix Merge pull request #250220 2023-09-11 23:44:42 +02:00
gvariant.nix lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
kernel.nix lib.kernel.unset: init 2023-05-01 10:23:42 +00:00
licenses.nix treewide: fix redirected and broken URLs 2023-11-11 10:49:01 +01:00
lists.nix lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
meta.nix lib.getExe': check arguments 2023-10-16 18:52:56 -04:00
minver.nix boostrap fetchurl: Add SRI support 2022-08-24 09:55:45 +02:00
modules.nix Merge pull request #249243 from lf-/jade/declarationsWithLocations 2023-09-17 19:43:07 +02:00
options.nix lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
README.md doc: separate commit header conventions for each area, info on docs changes. 2023-11-13 20:41:08 -08:00
source-types.nix lib.sourceTypes: simplify implementation 2022-05-30 16:27:34 +08:00
sources.nix lib: Take advantage of section descriptions 2023-11-20 03:02:11 +01:00
strings-with-deps.nix
strings.nix lib.strings: add replicate 2023-10-31 20:25:41 +01:00
trivial.nix lib.mirrorFunctionArgs: init 2023-11-07 01:58:04 +00:00
types.nix lib.types.string: Use lib.warn instead of deprecationMessage 2023-08-10 06:31:36 +02:00
versions.nix lib/versions: add pad 2022-12-21 12:58:21 +01:00
zip-int-bits.nix lib/zip-int-bits: fix typo: bitXOR -> bitXor 2022-06-09 20:04:37 +03:00

Nixpkgs lib

This directory contains the implementation, documentation and tests for the Nixpkgs lib library.

Overview

The evaluation entry point for lib is default.nix. This file evaluates to an attribute set containing two separate kinds of attributes:

  • Sub-libraries: Attribute sets grouping together similar functionality. Each sub-library is defined in a separate file usually matching its attribute name.

    Example: lib.lists is a sub-library containing list-related functionality such as lib.lists.take and lib.lists.imap0. These are defined in the file lists.nix.

  • Aliases: Attributes that point to an attribute of the same name in some sub-library.

    Example: lib.take is an alias for lib.lists.take.

Most files in this directory are definitions of sub-libraries, but there are a few others:

  • minver.nix: A string of the minimum version of Nix that is required to evaluate Nixpkgs.
  • tests: Tests, see Running tests
    • release.nix: A derivation aggregating all tests
    • misc.nix: Evaluation unit tests for most sub-libraries
    • *.sh: Bash scripts that run tests for specific sub-libraries
    • All other files in this directory exist to support the tests
  • systems: The lib.systems sub-library, structured into a directory instead of a file due to its complexity
  • path: The lib.path sub-library, which includes tests as well as a document describing the design goals of lib.path
  • All other files in this directory are sub-libraries

Module system

The module system spans multiple sub-libraries:

  • modules.nix: lib.modules for the core functions and anything not relating to option definitions
  • options.nix: lib.options for anything relating to option definitions
  • types.nix: lib.types for module system types

Reference documentation

Reference documentation for library functions is written above each function as a multi-line comment. These comments are processed using nixdoc and rendered in the Nixpkgs manual. The nixdoc README describes the comment format.

See the chapter on contributing to the Nixpkgs manual for how to build the manual.

Running tests

All library tests can be run by building the derivation in tests/release.nix:

nix-build tests/release.nix

Some commands for quicker iteration over parts of the test suite are also available:

# Run all evaluation unit tests in tests/misc.nix
# if the resulting list is empty, all tests passed
nix-instantiate --eval --strict tests/misc.nix

# Run the module system tests
tests/modules.sh

# Run the lib.sources tests
tests/sources.sh

# Run the lib.filesystem tests
tests/filesystem.sh

# Run the lib.path property tests
path/tests/prop.sh

# Run the lib.fileset tests
fileset/tests.sh

Commit conventions

  • Make sure you read about the commit conventions common to Nixpkgs as a whole.

  • Format the commit messages in the following way:

    lib.(section): (init | add additional argument | refactor | etc)
    
    (Motivation for change. Additional information.)
    

    Examples:

    • lib.getExe': check arguments

    • lib.fileset: Add an additional argument in the design docs

      Closes #264537