aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJade Lovelace <lix@jade.fyi>2024-05-23 15:16:10 -0700
committerjade <lix@jade.fyi>2024-05-24 02:22:58 +0000
commit745b5d3d4fd1d5cc97c84d559aa3dc25cc253b7f (patch)
tree6b783c17872d8a781ab10e8841675116fa52f334 /doc
parentd1fa446454ce6bb1119dac5caa181be977c24c61 (diff)
clang-tidy: work with angle brackets and external projects
Also fix the readme Change-Id: I422dff5536bf01d43983621aa01035bd77ac0252
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/rl-next/rename-lixexpr.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/manual/rl-next/rename-lixexpr.md b/doc/manual/rl-next/rename-lixexpr.md
index 698553c7f..32e3cfd09 100644
--- a/doc/manual/rl-next/rename-lixexpr.md
+++ b/doc/manual/rl-next/rename-lixexpr.md
@@ -22,10 +22,10 @@ Migration path:
To apply this migration automatically, remove all `<nix/>` from includes, so `#include <nix/expr.hh>` -> `#include <expr.hh>`.
Then, the correct paths will be resolved from the tangled mess, and the clang-tidy automated fix will work.
-Then run the following for out of tree projects:
+Then run the following for out of tree projects (header filter is set to only fix instances in headers in `../src` relative to the compiler's working directory, as would be the case in nix-eval-jobs or other things built with meson, e.g.):
```console
lix_root=$HOME/lix
(cd $lix_root/clang-tidy && nix develop -c 'meson setup build && ninja -C build')
-run-clang-tidy -checks='-*,lix-fixincludes' -load=$lix_root/clang-tidy/build/liblix-clang-tidy.so -p build/ -fix src
+run-clang-tidy -checks='-*,lix-fixincludes' -load=$lix_root/clang-tidy/build/liblix-clang-tidy.so -p build/ -header-filter '\.\./src/.*\.h' -fix src
```