Skip to content

docs: clarify install path variables #4662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MukundaKatta wants to merge 1 commit into
base: dev
Choose a base branch
from
+7 −0
Open

docs: clarify install path variables #4662

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ Other standard targets include:
The `Makefile` follows the [GNU Standard Makefile conventions](https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html),
allowing staged install, standard compilation flags, directory variables and command variables.

Common install variables include:
- `PREFIX` : sets the final installation prefix recorded in installed metadata, such as `libzstd.pc`.
For example, `make install PREFIX=/usr` installs under `/usr` instead of `/usr/local`.
- `DESTDIR` : prepends a staging directory to the install path without changing installed metadata.
For example, `make install PREFIX=/usr DESTDIR="$PWD/staging"` installs files under
`staging/usr`, while `libzstd.pc` still records `prefix=/usr`.

For advanced use cases, specialized flags which control binary generation and installation paths are documented
in [`lib/README.md`](lib/README.md#modular-build) for the `libzstd` library
and in [`programs/README.md`](programs/README.md#compilation-variables) for the `zstd` CLI.
Expand Down