[libvirt] [jenkins-ci PATCH] projects: Document rationale for skipping jobs

[Andrea Bolognani]

In general, we strive for full coverage and build all
projects on all targets; however, in some cases that's
simply not feasible and we have to skip the corresponding
job. Document the rationale for each such case.

Signed-off-by: Andrea Bolognani <abologna at redhat.com>
---
 projects/libvirt-dbus.yaml    | 3 +++
 projects/libvirt-sandbox.yaml | 3 +++
 projects/libvirt-tck.yaml     | 2 ++
 projects/libvirt.yaml         | 2 ++
 projects/virt-manager.yaml    | 1 +
 projects/virt-viewer.yaml     | 2 ++
 6 files changed, 13 insertions(+)

diff --git a/projects/libvirt-dbus.yaml b/projects/libvirt-dbus.yaml
index 3212465..88b4c88 100644
--- a/projects/libvirt-dbus.yaml
+++ b/projects/libvirt-dbus.yaml
@@ -18,6 +18,9 @@
             - libvirt-freebsd-11
       - autotools-check-job:
           parent_jobs: 'libvirt-dbus-master-build'
+          # libvirt-dbus' test suite uses Python 3, but Debian 8 doesn't
+          # include a recent enough version and CentOS 7 doesn't include
+          # Python 3 at all
           machines:
             - libvirt-debian-9
             - libvirt-fedora-27
diff --git a/projects/libvirt-sandbox.yaml b/projects/libvirt-sandbox.yaml
index da9bf77..6a474c8 100644
--- a/projects/libvirt-sandbox.yaml
+++ b/projects/libvirt-sandbox.yaml
@@ -1,6 +1,9 @@
 
 - project:
     name: libvirt-sandbox
+    # libvirt-sandbox is Linux only; among Linux platforms, CentOS 7 has
+    # to be excluded because it doesn't ship a version of xz suitable for
+    # statically linking against
     machines:
       - libvirt-debian-8
       - libvirt-debian-9
diff --git a/projects/libvirt-tck.yaml b/projects/libvirt-tck.yaml
index c406fda..38f8c09 100644
--- a/projects/libvirt-tck.yaml
+++ b/projects/libvirt-tck.yaml
@@ -1,6 +1,8 @@
 
 - project:
     name: libvirt-tck
+    # CentOS 7 doesn't include perl-generators, which is necessary to
+    # build libvirt-tck
     machines:
       - libvirt-debian-8
       - libvirt-debian-9
diff --git a/projects/libvirt.yaml b/projects/libvirt.yaml
index c64ac5b..ce4698e 100644
--- a/projects/libvirt.yaml
+++ b/projects/libvirt.yaml
@@ -10,6 +10,8 @@
           parent_jobs:
       - autotools-syntax-check-job:
           parent_jobs: 'libvirt-master-build'
+          # We limit syntax-check to Linux platforms because it calls some
+          # commands with more arguments than FreeBSD supports
           machines:
             - libvirt-centos-7
             - libvirt-debian-8
diff --git a/projects/virt-manager.yaml b/projects/virt-manager.yaml
index 84a95a6..6f806af 100644
--- a/projects/virt-manager.yaml
+++ b/projects/virt-manager.yaml
@@ -1,6 +1,7 @@
 
 - project:
     name: virt-manager
+    # virt-manager is Python 3 only, so it can't be built on CentOS 7
     machines:
       - libvirt-debian-9
       - libvirt-fedora-27
diff --git a/projects/virt-viewer.yaml b/projects/virt-viewer.yaml
index e68a23b..9188239 100644
--- a/projects/virt-viewer.yaml
+++ b/projects/virt-viewer.yaml
@@ -13,6 +13,8 @@
           parent_jobs: 'virt-viewer-master-syntax-check'
       - autotools-rpm-job:
           parent_jobs: 'virt-viewer-master-check'
+          # The spec file for virt-viewer requires a very recent version
+          # of spice-gtk, so we have to skip this job on older distros
           machines:
             - libvirt-fedora-28
             - libvirt-fedora-rawhide
-- 
2.17.1