MirrorHub/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-15 14:26:33 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
nixpkgs/lib
History
VwCSXg 147560180c lib.generators.toGitINI: added test 
Added basic generators.toGitINI test.
Mostly taken from 958c06303f/tests/modules/programs/git/git.nix.
The ${"\t} escape is used so that the lines aren't recognized as "Wrong
indent style".
2023-08-21 13:12:40 +02:00
..
path Merge pull request #247825 from tweag/lib.path-md 2023-08-12 08:10:15 +02:00
systems Merge pull request #238509 from amjoseph-nixpkgs/pr/knuth/respect 2023-08-16 11:14:12 -04:00
tests lib.generators.toGitINI: added test 2023-08-21 13:12:40 +02:00
ascii-table.nix
asserts.nix
attrsets.nix lib.attrsets.mergeAttrsList: init 2023-07-18 20:27:15 +02:00
cli.nix
customisation.nix lib.customisation.makeScope: Make overrideScope consistent with makeScopeWithSplicing 2023-08-14 18:46:47 +03:00
debug.nix
default.nix lib/meta.nix: introduce getExe' 2023-08-13 15:45:37 +02:00
deprecated.nix
derivations.nix
fetchers.nix
filesystem.nix
fixed-points.nix doc: Render lib.fixedPoints 2023-07-08 18:46:08 +02:00
flake.nix
generators.nix lib.generators.toGitINI: escape string values in configuration 2023-08-19 19:22:41 +02:00
kernel.nix
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
README.md lib: Add README 2023-07-18 17:22:42 +02:00
source-types.nix
sources.nix
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