Add a note about teuthology scheduling

Specifically, that we always schedule using the master branch.

Signed-off-by: Zack Cerza <zack.cerza@inktank.com>

diff --git a/teuthology/suite.py b/teuthology/suite.py
index ca409ed0d02eb8d2c160fd6c97993eb92b34267d..9d5f83f722388f6c46e3155db314bf8fa0faf379 100644 (file)
--- a/teuthology/suite.py
+++ b/teuthology/suite.py
@@ -105,6 +105,12 @@ def fetch_suite_repo(branch, test_name):
     Fetch the suite repo (and also the teuthology repo) so that we can use it
     to build jobs. Repos are stored in ~/src/.
 
+    The reason the teuthology repo is also fetched is that currently we use
+    subprocess to call teuthology-schedule to schedule jobs so we need to make
+    sure it is up-to-date. For that reason we always fetch the master branch
+    for test scheduling, regardless of what teuthology branch is requested for
+    testing.
+
     :returns: The path to the repo on disk
     """
     src_base_path = os.path.expanduser('~/src')