From: Zack Cerza Date: Mon, 11 May 2015 15:57:05 +0000 (-0600) Subject: Clarify Task.filter_hosts() docstring X-Git-Tag: 1.1.0~946^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=7263b75909bd4fc720f40ae83b3407e05d7da190;p=teuthology.git Clarify Task.filter_hosts() docstring Signed-off-by: Zack Cerza --- diff --git a/teuthology/task/__init__.py b/teuthology/task/__init__.py index e9112279f..32aed56ae 100644 --- a/teuthology/task/__init__.py +++ b/teuthology/task/__init__.py @@ -43,9 +43,10 @@ class Task(object): def filter_hosts(self): """ Look for a 'hosts' list in self.config. Each item in the list may - either be a role or a hostname. The task will then be run against only - those hosts which match one (or more) of the roles or hostnames - specified. + either be a role or a hostname. Builds a new Cluster object containing + only those hosts which match one (or more) of the roles or hostnames + specified. The filtered Cluster object is stored as self.cluster so + that the task may only run against those hosts. """ if not hasattr(self.ctx, 'cluster'): return