about summary refs log tree commit diff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorNaveen R. Iyer <iyernaveenr@gmail.com>2024-09-28 20:27:51 -0500
committerNaveen R. Iyer <iyernaveenr@gmail.com>2024-10-06 07:37:00 -0500
commit0df736c2a9a7b5ceddd90bfdd6aa991801145a54 (patch)
treeb1f2909335b95f3bb2d6ba191d9385021edfb1e6 /INSTALL.md
parented04567ba1d5956d1080fb8121caa005ce059e12 (diff)
downloadrust-0df736c2a9a7b5ceddd90bfdd6aa991801145a54.tar.gz
rust-0df736c2a9a7b5ceddd90bfdd6aa991801145a54.zip
add clarity for custom path installation
install.sysconfdir is another value, in addition to install.prefix,
that could be set for custom path installation.

Signed-off-by: Naveen R. Iyer <iyernaveenr@gmail.com>
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/INSTALL.md b/INSTALL.md
index ded0b59fc6c..74fcc58348b 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -79,9 +79,23 @@ See [the rustc-dev-guide for more info][sysllvm].
    ./configure
    ```
 
-   If you plan to use `x.py install` to create an installation, it is
-   recommended that you set the `prefix` value in the `[install]` section to a
-   directory: `./configure --set install.prefix=<path>`
+   If you plan to use `x.py install` to create an installation, you can either
+   set `DESTDIR` environment variable to your custom directory path:
+
+   ```bash
+   export DESTDIR=<path>
+   ```
+
+   or set `prefix` and `sysconfdir` in the `[install]` section to your custom
+   directory path:
+
+   ```sh
+   ./configure --set install.prefix=<path> --set install.sysconfdir=<path>
+   ```
+
+   When the `DESTDIR` environment variable is present, the `prefix` and
+   `sysconfdir` values are combined with the path from the `DESTDIR`
+   environment variable.
 
 3. Build and install: