From 21169062e6f842c3a920483cff2f7e4b7ffeaf2f Mon Sep 17 00:00:00 2001
From: Guillaume Chauvel <guillaume.chauvel@gmail.com>
Date: Mon, 22 Jun 2020 20:22:11 +0200
Subject: [PATCH] prepare-workspace: Add Role Variable in README.rst

Change-Id: I9bd85cbbf334a8d8c57b4adabf633e7046c273fd
---
 roles/prepare-workspace/README.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/roles/prepare-workspace/README.rst b/roles/prepare-workspace/README.rst
index 10ea71857..9ca8d4267 100644
--- a/roles/prepare-workspace/README.rst
+++ b/roles/prepare-workspace/README.rst
@@ -5,3 +5,10 @@ This role is intended to run before any other role in a Zuul job.
 It starts the Zuul console streamer on every host in the inventory,
 and then copies the prepared source repos to the working directory on
 every host.
+
+**Role Variables**
+
+.. zuul:rolevar:: zuul_workspace_root
+   :default: .
+
+   The directory into which the source repositories are copied.