about summary refs log tree commit diff
path: root/lib/trivial.nix
AgeCommit message (Collapse)AuthorFilesLines
2021-04-28lib.trivial.warnIf: initAlyssa Ross1-0/+3
It's a common pattern in Nixpkgs to want to emit a warning in certain cases, but not actually change behaviours. This is often expressed as either if cond then lib.warn "Don't do that thing" x else x Or (if cond then lib.warn "Don't do that thing" else lib.id) x Neither of which really expresses the intent here, because it looks like 'x' is being chosen conditionally. To make this clearer, I introduce a "warnIf" function, which makes it clear that the only thing being affected by the condition is whether the warning is generated, not the value being returned.
2021-04-05lib.trivial: fix typo "nixpks" -> "nixpkgs"Alyssa Ross1-1/+1
2021-01-26treewide: fold -> foldrBen Siraphob1-1/+1
2020-09-12lib: add importTOMLzimbatm1-0/+6
Complements the `lib.importJSON`. `builtins.readTOML` has been introduced in Nix 2.1.
2020-09-0721.03 is OkapiJonathan Ringer1-1/+1
* Okapi is an artiodactyl mammal native to Central Africa * https://en.wikipedia.org/wiki/Okapi
2020-07-20lib: toHex -> toHexString & toBase -> toBaseDigitsBas van Dijk1-10/+10
This makes the type of these functions more apparent from the name.
2020-07-20lib: add the toHex and toBase utility functionsBas van Dijk1-0/+51
`toHex` converts the given positive integer to a string of the hexadecimal representation of that integer. For example: ``` toHex 0 => "0" toHex 16 => "10" toHex 250 => "FA" ``` `toBase base i` converts the positive integer `i` to a list of it digits in the given `base`. For example: ``` toBase 10 123 => [ 1 2 3 ] toBase 2 6 => [ 1 1 0 ] toBase 16 250 => [ 15 10 ] ```
2020-02-1020.09 is Nightingaleworldofpeace1-1/+1
2020-01-20nixos/version: fix case where .git is a symlinkFranz Pletz1-1/+1
Before c9214c394b248e1f26e45dbe1be2bd82363af3a6 and 9d396d2e426b9a765de0b8999aa214f1259633e6 if .git is symlink the version would gracefully default to no git revision. With those changes an exception is thrown instead. This introduces a new function `pathIsGitRepo` that checks if `commitIdFromGitRepo` fails without error so we don't have to reimplement this logic again and can fail gracefully.
2020-01-10lib.commitIdFromGitRepo: support git-worktreeelseym1-1/+1
lib.commitIdFromGitRepo now resolves the refs from the parent repository in case the supplied path is a file containing the path to said repository. this adds support for git-worktree and things alike. see gitrepository-layout(5). this also: - adds a new boolean function lib.pathIsRegularFile to check whether a path is a regular file - patches lib.revisionWithDefault and the revision and versionSuffix attributes in config.system.nixos in order to support git-worktrees
2019-10-21lib/trivial: add `pipe` functionProfpatsch1-0/+37
`pipe` is a useful operator for creating pipelines of functions. It works around the usual problem of e.g. string operations becoming deeply nested functions. In principle, there are four different ways this function could be written: pipe val [ f1 .. fn ] pipe val [ fn .. f1 ] compose [ f1 .. fn ] val compose [ fn .. f1 ] val The third and fourth form mirror composition of functions, they would be the same as e.g. `(f1 << f2 << f3 .. << fn) val`. However, it is not clear which direction the list should have (as one can see in the second form, which is the most absurd. In order not to confuse users, we decide for the most “intuitive” form, which mirrors the way unix pipes work (thus the name `pipe`). The flow of data goes from left to right. Co-Authored-By: Silvan Mosberger <infinisil@icloud.com>
2019-09-0920.03 is MarkhorSamuel Leathers1-1/+1
* Markhor is a spiral horned animal that is on the endangered species list * https://en.wikipedia.org/wiki/Markhor
2019-04-29treewide: Remove usage of isNullDaniel Schaefer1-1/+1
isNull "is deprecated; just write e == null instead" says the Nix manual
2019-03-08lib: add `showWarnings`Jan Malakhovski1-1/+2
2019-02-2519.09 is Loris.Linus Heckemann1-1/+1
https://en.wikipedia.org/wiki/Loris
2018-11-15group the release infozimbatm1-0/+7
this makes the codename globally accessible in the repo. The release is not only for NixOS anymore.
2018-10-27lib/trivial: Update function comments for doc generationVincent Ambo1-30/+87
Expands on some of the function comments and add some of the special syntaxes recognised by nixdoc.
2018-10-05version.nix: extract revision-fetching functionGraham Christensen1-0/+10
2018-09-06lib: move assertMsg and assertOneOf to their own library fileProfpatsch1-39/+1
Since the `assertOneOf` uses `lib.generators`, they are not really trivial anymore and should go into their own library file.
2018-09-06lib/trivial: add assertOneOfProfpatsch1-0/+18
2018-09-06lib/trivial: add assertMsgProfpatsch1-0/+20
2018-09-03lib/trivial.nix: fix missing parensVladimír Čunát1-6/+6
Broken in 62dca7c9a; the tricky thing is that it depends on nix version. Explanation: https://github.com/NixOS/nix/issues/629
2018-07-26lib/trivial: move zipIntBits to its own fileProfpatsch1-40/+10
The amount of implementation detail really should not be the first thing in a prominent file called `trivial.nix`.
2018-07-26lib/trivial: unify & improve docstringsProfpatsch1-23/+61
- add section headers - unify comment syntax - add examples Tested with: nix-instantiate --strict --eval ./lib/tests/misc.nix
2018-07-03lib: add float option typeRichard Marko1-1/+1
2018-06-10lib: bitAnd, bitOr, bitXor (bitsize-agnostic fallback function) (#41491)volth1-0/+49
* lib: bitAnd, bitOr, bitXor * lib: test for bitAnd, bitOr, bitXor * lib: bitsize-agnostic zipIntBits * lib: bitNot * lib: bitNot
2018-06-05Revert "lib: bitAnd, bitOr, bitXor"Profpatsch1-43/+0
2018-06-01lib: bitAnd, bitOr, bitXorvolth1-0/+43
2018-04-28treewide: rename version attributesMaximilian Bosch1-3/+5
As suggested in https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745 the versioning attributes in `lib` should be consistent to `nixos/version` which implicates the following changes: * `lib.trivial.version` -> `lib.trivial.release` * `lib.trivial.suffix` -> `lib.trivial.versionSuffix` * `lib.nixpkgsVersion` -> `lib.version` As `lib.nixpkgsVersion` is referenced several times in `NixOS/nixpkgs`, `NixOS/nix` and probably several user's setups. As the rename will cause a notable impact it's better to keep `lib.nixpkgsVersion` as alias with a warning yielded by `builtins.trace`.
2018-04-28lib: deduplicate version/suffix referencesMaximilian Bosch1-4/+5
The logic regarding the generated `.version-suffix` file is already defined in `lib/trivial.nix` and shouldn't be duplicated in `nixos/version`.
2018-02-09lib: implement `compare`, `splitByAndCompare`, and `compareLists`Jan Malakhovski1-0/+36
2018-01-31Add setFunctionArgs lib function.Shea Levy1-1/+26
Among other things, this will allow *2nix tools to output plain data while still being composable with the traditional callPackage/.override interfaces.
2017-12-23Revert "nixos: doc: implement related packages in the manual"Graham Christensen1-25/+0
2017-12-07lib: implement `compare`, `splitByAndCompare`, and `compareLists`Jan Malakhovski1-0/+25
2017-09-16Convert libs to a fixed-pointGraham Christensen1-1/+2
This does break the API of being able to import any lib file and get its libs, however I'm not sure people did this. I made this while exploring being able to swap out docFn with a stub in #2305, to avoid functor performance problems. I don't know if that is going to move forward (or if it is a problem or not,) but after doing all this work figured I'd put it up anyway :) Two notable advantages to this approach: 1. when a lib inherits another lib's functions, it doesn't automatically get put in to the scope of lib 2. when a lib implements a new obscure functions, it doesn't automatically get put in to the scope of lib Using the test script (later in this commit) I got the following diff on the API: + diff master fixed-lib 11764a11765,11766 > .types.defaultFunctor > .types.defaultTypeMerge 11774a11777,11778 > .types.isOptionType > .types.isType 11781a11786 > .types.mkOptionType 11788a11794 > .types.setType 11795a11802 > .types.types This means that this commit _adds_ to the API, however I can't find a way to fix these last remaining discrepancies. At least none are _removed_. Test script (run with nix-repl in the PATH): #!/bin/sh set -eux repl() { suff=${1:-} echo "(import ./lib)$suff" \ | nix-repl 2>&1 } attrs_to_check() { repl "${1:-}" \ | tr ';' $'\n' \ | grep "\.\.\." \ | cut -d' ' -f2 \ | sed -e "s/^/${1:-}./" \ | sort } summ() { repl "${1:-}" \ | tr ' ' $'\n' \ | sort \ | uniq } deep_summ() { suff="${1:-}" depth="${2:-4}" depth=$((depth - 1)) summ "$suff" for attr in $(attrs_to_check "$suff" | grep -v "types.types"); do if [ $depth -eq 0 ]; then summ "$attr" | sed -e "s/^/$attr./" else deep_summ "$attr" "$depth" | sed -e "s/^/$attr./" fi done } ( cd nixpkgs #git add . #git commit -m "Auto-commit, sorry" || true git checkout fixed-lib deep_summ > ../fixed-lib git checkout master deep_summ > ../master ) if diff master fixed-lib; then echo "SHALLOW MATCH!" fi ( cd nixpkgs git checkout fixed-lib repl .types )
2017-08-30Add lib.mod: integer modulusDomen Kožar1-0/+10
2017-05-29lib: Move fixed-point combinators out of trivialJohn Ericson1-78/+0
Trivia != prelude. This is a better organized and less likely to scare off new contributors.
2017-05-05Merge pull request #24835 from Profpatsch/lib-doc-improvementsJörg Thalheim1-0/+2
Lib doc improvements
2017-04-25Merge pull request #25201 from ebzzry/fix-typoPeter Simons1-1/+1
Fix typo in trivial.nix
2017-04-25Fix typo in trivial.nixRommel Martinez1-1/+1
2017-04-18lib/trivial.nix: add type for fixProfpatsch1-0/+2
2017-04-17Merge pull request #24974 from Ericson2314/mapNullableJohn Ericson1-0/+3
Introduce `mapNullable` into lib and use it in a few places
2017-04-17Introduce `mapNullable` into lib and use it in a few placesJohn Ericson1-0/+3
Also simply some configure flag logic my grep also alerted me too.
2017-04-14Merge: fixup a bad mergeVladimír Čunát1-0/+9
For details see: https://github.com/NixOS/nixpkgs/commit/24444513fb5#commitcomment-21767916
2017-04-14Merge branch 'staging'Vladimír Čunát1-9/+0
2017-04-11treewide: use boolToString functionFranz Pletz1-0/+5
2017-04-07lib: Add composeExtensions for composing extension functionsShea Levy1-0/+9
2017-03-15lib/trivial: expand function docsProfpatsch1-3/+30
2017-01-30Excise use of importJSONEelco Dolstra1-19/+1
Putting information in external JSON files is IMHO not an improvement over the idiomatic style of Nix expressions. The use of JSON doesn't add anything over Nix expressions (in fact it removes expressive power). And scattering package info over lots of little files makes packages less readable over having the info in one file.
2016-11-30Remove fetchMD5warnEelco Dolstra1-3/+0
Deprecation warnings should not be used in Nixpkgs because they spam innocent "nix-env -qa" users with (in this case) dozens of messages that they can't do anything about. This also reverts commit 2ca883338389b7ab995924a0cab0211993bdf1da.