[PATCH 4/4] drvch: Document config file locations

Michal Privoznik via Devel posted 4 patches 1 month, 1 week ago
[PATCH 4/4] drvch: Document config file locations
Posted by Michal Privoznik via Devel 1 month, 1 week ago
From: Michal Privoznik <mprivozn@redhat.com>

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
---
 docs/drvch.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/drvch.rst b/docs/drvch.rst
index 2f900b785b..b9effc4409 100644
--- a/docs/drvch.rst
+++ b/docs/drvch.rst
@@ -28,6 +28,22 @@ But all other transport modes are supported too
 (see `documentation <uri.html#remote-uris>`__).
 
 
+Location of configuration files
+-------------------------------
+
+The CH driver comes with sane default values. However, during its
+initialization it reads a configuration file which offers system
+administrator or an user to override some of that default. The location
+of the file depends on the connection URI, as follows:
+
+=================== ======================================
+``ch:///system``    ``/etc/libvirt/ch.conf``
+``ch:///session``   ``$XDG_CONFIG_HOME/libvirt/ch/ch.conf``
+=================== ======================================
+
+If ``$XDG_CONFIG_HOME`` is not set in the environment, it defaults to
+``$HOME/.config``.
+
 Example guest domain XML configurations
 ---------------------------------------
 
-- 
2.51.0