Skip to content

Commit d3493bf

Browse files
committed
docs(tree): update descriptions for --depth flag
1 parent 867aab2 commit d3493bf

File tree

4 files changed

+12
-1
lines changed

4 files changed

+12
-1
lines changed

src/doc/man/cargo-tree.md

+3
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ Prune the given package from the display of the dependency tree.
9696
{{#option "`--depth` _depth_" }}
9797
Maximum display depth of the dependency tree. A depth of 1 displays the direct
9898
dependencies, for example.
99+
100+
If the given value is `workspace`, only shows the dependencies that are member
101+
of the current workspace, instead.
99102
{{/option}}
100103

101104
{{#option "`--no-dedupe`" }}

src/doc/man/generated_txt/cargo-tree.txt

+3
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ OPTIONS
8585
Maximum display depth of the dependency tree. A depth of 1 displays
8686
the direct dependencies, for example.
8787

88+
If the given value is workspace, only shows the dependencies that
89+
are member of the current workspace, instead.
90+
8891
--no-dedupe
8992
Do not de-duplicate repeated dependencies. Usually, when a package
9093
has already displayed its dependencies, further occurrences will not

src/doc/src/commands/cargo-tree.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ subtree of the package given to <code>-p</code>.</dd>
9191

9292
<dt class="option-term" id="option-cargo-tree---depth"><a class="option-anchor" href="#option-cargo-tree---depth"></a><code>--depth</code> <em>depth</em></dt>
9393
<dd class="option-desc">Maximum display depth of the dependency tree. A depth of 1 displays the direct
94-
dependencies, for example.</dd>
94+
dependencies, for example.</p>
95+
<p>If the given value is <code>workspace</code>, only shows the dependencies that are member
96+
of the current workspace, instead.</dd>
9597

9698

9799
<dt class="option-term" id="option-cargo-tree---no-dedupe"><a class="option-anchor" href="#option-cargo-tree---no-dedupe"></a><code>--no-dedupe</code></dt>

src/etc/man/cargo-tree.1

+3
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ Prune the given package from the display of the dependency tree.
9393
.RS 4
9494
Maximum display depth of the dependency tree. A depth of 1 displays the direct
9595
dependencies, for example.
96+
.sp
97+
If the given value is \fBworkspace\fR, only shows the dependencies that are member
98+
of the current workspace, instead.
9699
.RE
97100
.sp
98101
\fB\-\-no\-dedupe\fR

0 commit comments

Comments
 (0)