From: Tobias Ulmer <tu@emlix.com>
Date: Wed, 8 Jan 2014 17:38:21 +0000 (+0100)
Subject: Make load_result_config() plural and add documentation
X-Git-Tag: e2factory-2.3.15rc1~274
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=b5826fde8e630483a650e8fdedfdd6c99b918a32;p=e2factory.git

Make load_result_config() plural and add documentation

Reflect that this function loads all result configs into the info table.

Signed-off-by: Tobias Ulmer <tu@emlix.com>
---

diff --git a/local/e2tool.lua b/local/e2tool.lua
index 5dd2bfb..5c928c0 100644
--- a/local/e2tool.lua
+++ b/local/e2tool.lua
@@ -1113,8 +1113,11 @@ local function gather_result_paths(info, basedir, results)
     return results
 end
 
---- load result config.
-local function load_result_config(info)
+--- Load all result configs. Creates and populates the info.results dictionary.
+-- @param info Info table.
+-- @return True on success, false on error.
+-- @return Error object on failure.
+local function load_result_configs(info)
     local e = err.new("error loading result configuration")
     info.results = {}
 
@@ -1169,7 +1172,7 @@ local function load_result_config(info)
             info.results[name] = item.data
         end
     end
-    return true, nil
+    return true
 end
 
 --- Read project configuration file.
@@ -1360,7 +1363,7 @@ function e2tool.collect_project_info(info, skip_load_config)
         return false, e:cat(re)
     end
 
-    rc, re = load_result_config(info)
+    rc, re = load_result_configs(info)
     if not rc then
         return false, e:cat(re)
     end