summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Valim <jose.valim@dashbit.co>2021-12-10 23:23:19 +0100
committerJosé Valim <jose.valim@dashbit.co>2021-12-10 23:23:19 +0100
commit97ac2742f724494b1d3b55c30639a1e7e631db37 (patch)
tree3ff2d7fdda9efe7700b57ba5a48e125d85f790b0
parentdabfc587801882eca8a5681f7a91d893853395f3 (diff)
downloadelixir-97ac2742f724494b1d3b55c30639a1e7e631db37.tar.gz
Improve xref docs
-rw-r--r--lib/mix/lib/mix/tasks/xref.ex15
1 files changed, 7 insertions, 8 deletions
diff --git a/lib/mix/lib/mix/tasks/xref.ex b/lib/mix/lib/mix/tasks/xref.ex
index d897cb846..e358cf797 100644
--- a/lib/mix/lib/mix/tasks/xref.ex
+++ b/lib/mix/lib/mix/tasks/xref.ex
@@ -83,11 +83,12 @@ defmodule Mix.Tasks.Xref do
* `--label` - only shows relationships with the given label.
The labels are "compile", "export" and "runtime". By default,
the `--label` option simply filters the printed graph to show
- only relationships with the given label. If you want to
- effectively filter the graph, you can pass the `--only-direct`
- flag. There is also a special label called "compile-connected"
- that keeps only compile-time files with at least one transitive
- dependency. See "Dependencies types" section below.
+ only relationships with the given label. You can pass `--only-direct`
+ to trim the graph to only the nodes that have the direct
+ relationship given by label. There is also a special label
+ called "compile-connected" that keeps only compile-time files
+ with at least one transitive dependency. See "Dependencies types"
+ section below.
* `--only-direct` - keeps only files with the direct relationship
given by `--label`
@@ -235,9 +236,7 @@ defmodule Mix.Tasks.Xref do
Those options are shared across all modes:
* `--fail-above` - generates a failure if the relevant metric is above the
- given threshold. This metric is the number of references, except for
- `--format cycles` where it is the number of cycles, and `--format stats`
- which has none.
+ given threshold. Applies to all modes except `mix xref graph --format stats`.
* `--include-siblings` - includes dependencies that have `:in_umbrella` set
to true in the current project in the reports. This can be used to find