about summary refs log tree commit diff
path: root/lib/debug.nix
AgeCommit message (Collapse)AuthorFilesLines
2018-10-29lib/debug: Update documentation comments for docs generationVincent Ambo1-19/+75
Documents functions in `lib.debug` for docs generation with nixdoc. Note that type signatures and clearer descriptions are still missing on some of these functions, but this is good enough for a first run.
2018-07-15lib.debug: fix traceValSeqFnMatthieu Coudron1-1/+1
was calling the wrong parent version.
2018-04-27lib/debug: add replacement instructions & release notesProfpatsch1-6/+13
for every deprecated function.
2018-04-27lib/debug: document module & functions, prune importsProfpatsch1-37/+81
2018-04-27lib/debug: deprecate `traceCallXml`Profpatsch1-2/+4
Incompletely documented, and a FIXME/bug that has been there for years.
2018-04-27lib/debug: deprecate `addErrorContextToAttrs`Profpatsch1-4/+6
The function isn’t used anywhere and `addErrorContext` is an undocumented builtin. The builtin is explicitely qualified at its two uses in the module system.
2018-04-27lib/debug: deprecate `traceValIfNot`Profpatsch1-2/+3
The function is only used in exactly one module and overly specific (`c` must be a true predicate for `x`, if not, a specific trace is called).
2018-04-27lib/debug: deprecate attrNamesToStr, traceXMLVal(Marked)Profpatsch1-4/+15
`attrNamesToStr` is very specific (and pretty trivial), so it doesn’t make sense to have it in the library. `traceXMLVal(Marked)` are just a builtin and `trace` and not very useful in general (trace output should not be parsed anyway).
2018-04-27lib/debug: deprecate & modernize showValProfpatsch1-13/+19
The code is re-implemented in terms of `generators.toPretty`, but is strictly less general than `traceValSeqN`, so we deprecate it.
2018-04-27lib/debug: remove the deprecated strict functionProfpatsch1-6/+2
The grace period was long enough.
2018-04-27lib/debug: add traceValFn, traceValSeqFn, traceValSeqNFnProfpatsch1-3/+6
Being able to modify the value on-the-fly before printing is very useful in practice.
2018-01-31Add setFunctionArgs lib function.Shea Levy1-2/+2
Among other things, this will allow *2nix tools to output plain data while still being composable with the traditional callPackage/.override interfaces.
2017-09-16Convert libs to a fixed-pointGraham Christensen1-1/+3
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-06-22lib/debug: traceSeqN & traceSeqValNProfpatsch1-0/+24
Strict trace functions that only go down to a specified depth. Handy to get a better picture and prevent infinite recursions.
2017-03-11lib: fix mixed tab/space indents, trailing whitespace, etcBenjamin Staffin1-7/+7
Nix style seems to have settled on not using spaces between bound variable names and the lambda : so I also tried to make those somewhat more consistent throughout.
2016-06-26debug.nix: deprecate strictProfpatsch1-21/+3
Replace the implementation by seq and add a deprecation warning. The semantics seems a little bit off, but the function should only be used for debugging.
2016-06-26debug.nix: add traceSeq & traceValSeqProfpatsch1-0/+4
Debugging functions that strictly deep-evaluate the argument that should be traced.
2015-03-26lib: cleanup a little bit, add traceIfJan Malakhovski1-4/+6
2014-10-05Remove obsolete checks for missing primopsEelco Dolstra1-20/+12
2013-10-10Move pkgs/lib/ to lib/Eelco Dolstra1-0/+119