From d3ca3e9621560df7fa9aa6c78ee3faa40f6c2692 Mon Sep 17 00:00:00 2001
From: Marc Bonnici <marc.bonnici@arm.com>
Date: Tue, 22 May 2018 14:51:38 +0100
Subject: [PATCH] framework/config: Rename `by_spec` to `by_workload` execution
 order

Rename the `by_spec` execution order to `by_workload` and update
description for clarification.
---
 wa/framework/configuration/core.py      | 8 +++++---
 wa/framework/configuration/execution.py | 4 ++--
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/wa/framework/configuration/core.py b/wa/framework/configuration/core.py
index 8eee49d8..80d8a03a 100644
--- a/wa/framework/configuration/core.py
+++ b/wa/framework/configuration/core.py
@@ -547,7 +547,7 @@ class RunConfiguration(Configuration):
             'execution_order',
             kind=str,
             default='by_iteration',
-            allowed_values=['by_iteration', 'by_spec', 'by_section', 'random'],
+            allowed_values=['by_iteration', 'by_section', 'by_workload', 'random'],
             description='''
             Defines the order in which the agenda spec will be executed. At the
             moment, the following execution orders are supported:
@@ -572,9 +572,11 @@ class RunConfiguration(Configuration):
 
                         X.A1, X.B1, Y.A1, Y.B1, X.A2, X.B2, Y.A2, Y.B2
 
-            ``"by_spec"``
+            ``"by_workload"``
                 All iterations of the first spec are executed before moving on
-                to the next spec. E.g. A1 A2 A3 B1 C1 C2.
+                to the next spec. E.g::
+
+                        X.A1, X.A2, Y.A1, Y.A2, X.B1, X.B2, Y.B1, Y.B2
 
             ``"random"``
                 Execution order is entirely random.
diff --git a/wa/framework/configuration/execution.py b/wa/framework/configuration/execution.py
index 46aa8ba3..d9192da7 100644
--- a/wa/framework/configuration/execution.py
+++ b/wa/framework/configuration/execution.py
@@ -125,7 +125,7 @@ class ConfigManager(object):
         self._jobs_generated = True
 
 
-def permute_by_job(specs):
+def permute_by_workload(specs):
     """
     This is that "classic" implementation that executes all iterations of a
     workload spec before proceeding onto the next spec.
@@ -205,7 +205,7 @@ def permute_randomly(specs):
 
 permute_map = {
     'by_iteration': permute_by_iteration,
-    'by_job': permute_by_job,
+    'by_workload': permute_by_workload,
     'by_section': permute_by_section,
     'random': permute_randomly,
 }