nordic-dev.net/nixpkgs
nordic-dev.net/nixpkgs
2
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-23 15:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
191dee486f
nixpkgs/lib
History
Artturin 5472b08075 lib/systems: disable pipewireSupport in qemu-user 
Option added in 5b0ed68c10

it causes infinite recursion in cross builds

There's a another inf rec that needs 6946977de0 which is in staging
2023-09-08 00:23:19 +03:00
..
fileset lib.fileset.toSource: init 2023-09-01 15:46:04 +02:00
path Merge pull request #247825 from tweag/lib.path-md 2023-08-12 08:10:15 +02:00
systems lib/systems: disable pipewireSupport in qemu-user 2023-09-08 00:23:19 +03:00
tests Merge pull request #245623 from tweag/fileset.toSource 2023-09-02 04:07:02 +02:00
ascii-table.nix strings: add escapeQuery for url encoding 2023-03-03 20:48:55 +01:00
asserts.nix
attrsets.nix lib.attrsets.mergeAttrsList: init 2023-07-18 20:27:15 +02:00
cli.nix
customisation.nix makeScopeWithSplicing: fix makeScopeWithSplicing' call 2023-08-21 19:57:34 +03:00
debug.nix lib/debug: remove unused let bindings 2023-06-23 09:41:04 +00:00
default.nix Merge pull request #245623 from tweag/fileset.toSource 2023-09-02 04:07:02 +02:00
deprecated.nix
derivations.nix lib.derivations: fix comment typo 2023-06-02 23:57:30 +08:00
fetchers.nix
filesystem.nix lib/filesystem: remove unused let bindings 2023-06-23 09:41:04 +00:00
fixed-points.nix doc: Render lib.fixedPoints 2023-07-08 18:46:08 +02:00
flake.nix
generators.nix nixos/dconf: add settings support 2023-08-15 19:20:39 +08:00
gvariant.nix lib/gvariant: init 2023-08-15 19:20:39 +08:00
kernel.nix lib.kernel.unset: init 2023-05-01 10:23:42 +00:00
licenses.nix licenses: add Hippocratic License v3.0 2023-07-07 12:37:12 +02:00
lists.nix Merge pull request #243511 from tweag/lib.lists.hasPrefix 2023-08-14 21:15:54 +02:00
meta.nix Merge pull request #248895 from Scrumplex/getExe2 2023-08-16 02:19:22 +02:00
minver.nix
modules.nix lib/modules: Report a better error when option tree has bare type 2023-08-18 11:36:51 +02:00
options.nix lib: turn *MD functions into aliases 2023-06-13 16:56:32 +02:00
README.md lib.fileset.toSource: init 2023-09-01 15:46:04 +02:00
source-types.nix
sources.nix lib/sources: remove unused let bindings 2023-06-23 09:41:04 +00:00
strings-with-deps.nix
strings.nix lib.removePrefix: Optimise 2023-08-14 23:32:42 +02:00
trivial.nix Merge pull request #235625 from ShamrockLee/lib-doc-tidy 2023-08-10 12:00:36 +02:00
types.nix lib.types.string: Use lib.warn instead of deprecationMessage 2023-08-10 06:31:36 +02:00
versions.nix
zip-int-bits.nix

README.md

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