jade/blog
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mention nix-doc 0.5.0

Browse source
This commit is contained in:
Jade 2021-07-03 19:59:34 -07:00
parent b826defb88
commit 0873fc3a2b
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
content/posts/finding-functions-in-nixpkgs.md
View file

@ -15,10 +15,24 @@ nixpkgs going from trivial to some effort.
## Simple
These work on functions that have no wrappers around them, which account for
most library functions in nixpkgs.
most library functions in nixpkgs. The option for `ctags` is a little bit
better because it will just show you the source code which you can subsequently
trace through.
### Static
#### ctags
As of version 0.5.0 (released 2021-07-03), `nix-doc` supports emitting ctags
files with `nix-doc tags .` from a nixpkgs checkout.
This lets you `:tag` things in vim or other editor supporting ctags and
instantly jump to them by name, as well as `CTRL-]` to jump to the symbol under
the cursor. It's clever enough to distinguish functions from other values at a
syntax level, but like every ctags tool that's about where it stops.
#### Search tools
Static analysis is, in my view, slightly slower, since you can't be sure you're
getting the function you're seeing in the interactive environment in `nix repl`
or elsewhere.