aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Schwartz <eschwartz@archlinux.org>2020-11-17 00:39:45 -0500
committerJussi Pakkanen <jpakkane@gmail.com>2020-11-17 17:49:18 +0200
commit98ddd472ed42b27fd636857ca0e6895604029998 (patch)
tree9715a37f8f4db09bea823f2ede7ae1e3cecb762b
parent42ba8efaf220bceca7850f2ffe0d84ee426f7b34 (diff)
downloadmeson-98ddd472ed42b27fd636857ca0e6895604029998.zip
meson-98ddd472ed42b27fd636857ca0e6895604029998.tar.gz
meson-98ddd472ed42b27fd636857ca0e6895604029998.tar.bz2
doc: add much-needed accuracy to pip installation instructions [skip ci]
- mention installing from local sources, not PyPI - warn against --user installs, which too often screw up users that then cannot install projects because ~/.local won't be in sudo's PYTHONPATH - advise installing with sudo -- current versions of pip assume --user for you rather than failing with permission errors, which is great unless, like meson, there are compelling reasons to need to install as root
-rw-r--r--docs/markdown/Getting-meson.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/markdown/Getting-meson.md b/docs/markdown/Getting-meson.md
index e0e5722..3568dfc 100644
--- a/docs/markdown/Getting-meson.md
+++ b/docs/markdown/Getting-meson.md
@@ -23,12 +23,17 @@ a pull-request process that runs CI and tests several platforms.
## Installing Meson with pip
Meson is available in the [Python Package Index] and can be installed with
-`pip3 install meson` which requires root and will install it system-wide.
+`sudo pip3 install meson` which requires root and will install it system-wide.
+
+If you have downloaded a copy of the meson sources already, you can install it
+with `sudo pip3 install path/to/source/root/`.
Alternatively, you can use `pip3 install --user meson` which will install it
for your user and does not require any special privileges. This will install
the package in `~/.local/`, so you will have to add `~/.local/bin` to your
-`PATH`.
+`PATH`, and `sudo meson install` will be completely broken since the
+program will not be available to root. Only use a user copy of meson if you
+do not care about installing projects as root.
## Installing Meson and Ninja with the MSI installer