From 4e00f63d4f8fe265d157a16303add3542cc3c91c Mon Sep 17 00:00:00 2001
From: Fabien Boucher <fboucher@redhat.com>
Date: Apr 03 2020 13:19:37 +0000
Subject: Fix jobs descriptions


---

diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml
index 13f1f33..495ab51 100644
--- a/zuul.d/jobs.yaml
+++ b/zuul.d/jobs.yaml
@@ -9,7 +9,7 @@
     name: rpm-mock-build
     parent: base-rpm-build
     description: |
-      Base job to build rpm(s) from a distgit repository.
+      Job to build rpm(s) from a distgit repository using mock.
 
       Responds to these variables:
 
@@ -69,7 +69,9 @@
     name: rpm-local-build
     parent: base-rpm-build
     description: |
-      Base job to build rpm(s) from a distgit repository.
+      Job to build rpm(s) from a distgit repository locally
+      using rpmbuild. The proper build target must be provided
+      in the attached nodeset.
 
       Responds to these variables:
 
@@ -94,6 +96,22 @@
          build_from_source is set and discovered source
          name is failing leading to a %prep phase failure.
 
+      .. zuul:jobvar:: source_location
+         : default: undefined
+
+         This is only useful when build_from_source is set.
+         This tells the job that the source to packaged is not
+         stored in the same repository and must be retrieved.
+         if set, the format must be an object with clone_target_dir
+         (mandatory) which is the directory where the job expects
+         to find the source to package and clone_url (optional)
+         that tells the job to fetch the source from a git url.
+         If the job adds the source repository as a required-projects
+         then clone_url is not needed.
+         eg.
+         {'clone_url': 'https://review.opendev.org/gear'
+          'clone_target_dir': 'src/review.opendev.org/gear'}
+
       .. zuul:jobvar:: repos
          : default: []