BoomMicrophone/nixpkgs-suyu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
nixpkgs-suyu/lib
History
Adam Joseph a0c77aecaa lib.systems: add ubootArch 
u-boot has its own rosetta stone, almost but not exactly the same as
the Linux kernel's.  This commit adds it and the two cases where it
diverges.
2023-08-14 01:34:07 -07:00
..
path Merge pull request #247825 from tweag/lib.path-md 2023-08-12 08:10:15 +02:00
systems lib.systems: add ubootArch 2023-08-14 01:34:07 -07:00
tests Merge pull request #243139 from hercules-ci/modules-test-default-argument 2023-08-02 20:12:37 +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 Revert "lib.customisation: uncurry makeScopeWithSplicing" 2023-07-28 23:04:09 +02:00
debug.nix lib/debug: remove unused let bindings 2023-06-23 09:41:04 +00:00
default.nix lib/options: remove literalDocBook 2023-06-13 16:56:30 +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 lib/generators/toKeyValue: add indent parameter 2023-07-22 13:49:30 +02: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 lib.lists.commonPrefix: init 2023-07-20 22:42:01 +02:00
meta.nix treewide: update mainProgram docs 2023-08-04 20:31:16 +03:00
minver.nix
modules.nix Merge pull request #245271 from sternenseemann/module-system-merge-no-type 2023-07-27 10:55:08 +02:00
options.nix lib: turn *MD functions into aliases 2023-06-13 16:56:32 +02:00
README.md lib: Add README 2023-07-18 17:22:42 +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: simplify stringToCharacters 2023-06-22 18:27:15 -04: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