From d3493bfe89c5ea48b2a48c76dd7c62fb9edee580 Mon Sep 17 00:00:00 2001
From: Shoyu Vanilla <modulo641@gmail.com>
Date: Fri, 13 Dec 2024 04:49:12 +0900
Subject: [PATCH] docs(tree): update descriptions for `--depth` flag

---
 src/doc/man/cargo-tree.md                | 3 +++
 src/doc/man/generated_txt/cargo-tree.txt | 3 +++
 src/doc/src/commands/cargo-tree.md       | 4 +++-
 src/etc/man/cargo-tree.1                 | 3 +++
 4 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/doc/man/cargo-tree.md b/src/doc/man/cargo-tree.md
index ce99b761e7dc..fc3521c99399 100644
--- a/src/doc/man/cargo-tree.md
+++ b/src/doc/man/cargo-tree.md
@@ -96,6 +96,9 @@ Prune the given package from the display of the dependency tree.
 {{#option "`--depth` _depth_" }}
 Maximum display depth of the dependency tree. A depth of 1 displays the direct
 dependencies, for example.
+
+If the given value is `workspace`, only shows the dependencies that are member
+of the current workspace, instead.
 {{/option}}
 
 {{#option "`--no-dedupe`" }}
diff --git a/src/doc/man/generated_txt/cargo-tree.txt b/src/doc/man/generated_txt/cargo-tree.txt
index 1af730aff535..0fc542f429f0 100644
--- a/src/doc/man/generated_txt/cargo-tree.txt
+++ b/src/doc/man/generated_txt/cargo-tree.txt
@@ -85,6 +85,9 @@ OPTIONS
            Maximum display depth of the dependency tree. A depth of 1 displays
            the direct dependencies, for example.
 
+           If the given value is workspace, only shows the dependencies that
+           are member of the current workspace, instead.
+
        --no-dedupe
            Do not de-duplicate repeated dependencies. Usually, when a package
            has already displayed its dependencies, further occurrences will not
diff --git a/src/doc/src/commands/cargo-tree.md b/src/doc/src/commands/cargo-tree.md
index 154939a28efb..9418eaa9d1ce 100644
--- a/src/doc/src/commands/cargo-tree.md
+++ b/src/doc/src/commands/cargo-tree.md
@@ -91,7 +91,9 @@ subtree of the package given to <code>-p</code>.</dd>
 
 <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>
 <dd class="option-desc">Maximum display depth of the dependency tree. A depth of 1 displays the direct
-dependencies, for example.</dd>
+dependencies, for example.</p>
+<p>If the given value is <code>workspace</code>, only shows the dependencies that are member
+of the current workspace, instead.</dd>
 
 
 <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>
diff --git a/src/etc/man/cargo-tree.1 b/src/etc/man/cargo-tree.1
index c951460b0282..25045b3f92dc 100644
--- a/src/etc/man/cargo-tree.1
+++ b/src/etc/man/cargo-tree.1
@@ -93,6 +93,9 @@ Prune the given package from the display of the dependency tree.
 .RS 4
 Maximum display depth of the dependency tree. A depth of 1 displays the direct
 dependencies, for example.
+.sp
+If the given value is \fBworkspace\fR, only shows the dependencies that are member
+of the current workspace, instead.
 .RE
 .sp
 \fB\-\-no\-dedupe\fR