aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Skultety <eskultet@redhat.com>2022-07-14 12:29:22 +0200
committerErik Skultety <eskultet@redhat.com>2022-07-14 15:14:19 +0200
commit6af299348aab3122e24cdc7e99e127c2560e59bf (patch)
tree55c5e179572785e99a68a55706b26ef4ab17de6e
parentd753ee1376e0b96a00c97c9cffbb3a7172452377 (diff)
downloadlibvirt-ci-6af299348aab3122e24cdc7e99e127c2560e59bf.zip
libvirt-ci-6af299348aab3122e24cdc7e99e127c2560e59bf.tar.gz
libvirt-ci-6af299348aab3122e24cdc7e99e127c2560e59bf.tar.bz2
README: Move 'External projects lists' to an individual RST document
Signed-off-by: Erik Skultety <eskultet@redhat.com>
-rw-r--r--docs/projects.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/projects.rst b/docs/projects.rst
new file mode 100644
index 0000000..6a08909
--- /dev/null
+++ b/docs/projects.rst
@@ -0,0 +1,17 @@
+Externally defined project package lists
+========================================
+
+Historically all projects have been defined in data files at the location::
+
+ lcitool/ansible/vars/projects/$NAME.yml
+
+This creates a chicken and egg problem when a project changes its build
+pre-requisites, as libvirt-ci needs to be updated if-and-only-if the
+project is updated and vice-versa.
+
+To solve this problem, it is now possible to define the project package
+lists outside the libvirt-ci repository. They can be located by giving
+the ``--data-dir DIR`` argument to ``lcitool``. When this is present,
+data files will be additionally loaded from::
+
+ $DIR/projects/$NAME.yml