Reference options-target-dir in cargo install documentation

rust-lang · Jun 21, 2020 · 291fb41 · 291fb41
1 parent 1f2de1e
commit 291fb41
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/src/doc/man/cargo-install.adoc b/src/doc/man/cargo-install.adoc
@@ -143,6 +143,8 @@ include::options-features.adoc[]
 
 include::options-target-triple.adoc[]
 
+include::options-target-dir.adoc[]
+
 *--debug*::
     Build with the `dev` profile instead the `release` profile.
 

diff --git a/src/doc/man/generated/cargo-install.html b/src/doc/man/generated/cargo-install.html
@@ -258,6 +258,13 @@ <h3 id="cargo_install_compilation_options">Compilation Options</h3>
 <a href="../guide/build-cache.html">build cache</a> documentation for more details.</p>
 </div>
 </dd>
+<dt class="hdlist1"><strong>--target-dir</strong> <em>DIRECTORY</em></dt>
+<dd>
+<p>Directory for all generated artifacts and intermediate files. May also be
+specified with the <code>CARGO_TARGET_DIR</code> environment variable, or the
+<code>build.target-dir</code> <a href="../reference/config.html">config value</a>. Defaults
+to <code>target</code> in the root of the workspace.</p>
+</dd>
 <dt class="hdlist1"><strong>--debug</strong></dt>
 <dd>
 <p>Build with the <code>dev</code> profile instead the <code>release</code> profile.</p>

diff --git a/src/etc/man/cargo-install.1 b/src/etc/man/cargo-install.1
@@ -2,12 +2,12 @@
 .\"     Title: cargo-install
 .\"    Author: [see the "AUTHOR(S)" section]
 .\" Generator: Asciidoctor 2.0.10
-.\"      Date: 2020-06-14
+.\"      Date: 2020-06-20
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-INSTALL" "1" "2020-06-14" "\ \&" "\ \&"
+.TH "CARGO\-INSTALL" "1" "2020-06-20" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -345,6 +345,16 @@ target artifacts are placed in a separate directory. See the
 documentation for more details.
 .RE
 .sp
+\fB\-\-target\-dir\fP \fIDIRECTORY\fP
+.RS 4
+Directory for all generated artifacts and intermediate files. May also be
+specified with the \fBCARGO_TARGET_DIR\fP environment variable, or the
+\fBbuild.target\-dir\fP \c
+.URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "."
+Defaults
+to \fBtarget\fP in the root of the workspace.
+.RE
+.sp
 \fB\-\-debug\fP
 .RS 4
 Build with the \fBdev\fP profile instead the \fBrelease\fP profile.