aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorErik Skultety <eskultet@redhat.com>2023-03-31 11:43:30 +0200
committerErik Skultety <eskultet@redhat.com>2023-03-31 11:47:10 +0200
commitd11d57c61c80697838353c4942249487b5ae64bc (patch)
tree3dd043ca510e575fd45c629b5926e75d9618e08a /docs
parent48c7e39e0f05810c30564f800813e00b15f3cf7c (diff)
downloadlibvirt-ci-d11d57c61c80697838353c4942249487b5ae64bc.zip
libvirt-ci-d11d57c61c80697838353c4942249487b5ae64bc.tar.gz
libvirt-ci-d11d57c61c80697838353c4942249487b5ae64bc.tar.bz2
docs: Add a section on running lcitool directly from git and reword
Without a section header, this information could be easily overlooked, so put it in a dedicated section. Signed-off-by: Erik Skultety <eskultet@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/installation.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index 996dd44..9d60463 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -106,6 +106,9 @@ with pip like this:
which will create the necessary links to your working directory and so you
won't need to re-install the lcitool package locally after every code change.
-If you don't want to install this tool into your environment and instead wish
-to run it directly, just run the `bin/lcitool` script that is located at the
-root of this repository.
+Running lcitool from git
+------------------------
+If you don't want to install this tool into your environment at all and instead
+wish to run it directly, just run the ``bin/lcitool`` script that is located at
+the root of this repository which will mangle ``PYTHONPATH`` so that the
+package is imported correctly by Python.