From: Tobias Ulmer <tu@emlix.com>
Date: Wed, 22 Jan 2014 20:04:44 +0000 (+0100)
Subject: Add note about what return values resultid() expects
X-Git-Tag: e2factory-2.3.15rc1~246
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=c6a21c4aca03fb6fbabb6669434a682eca42ace4;p=e2factory.git

Add note about what return values resultid() expects

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

diff --git a/local/e2tool.lua b/local/e2tool.lua
index 4ce6c85..5f1fef3 100644
--- a/local/e2tool.lua
+++ b/local/e2tool.lua
@@ -2255,6 +2255,7 @@ end
 --                             feature.
 -- @field check_result Called f(info, resultname).
 -- @field resultid Called f(info, resultname).
+--        Returns nil on error, false to skip, or a resultid string.
 -- @field pbuildid Called f(info, resultname).
 -- @field dlist Called f(info, resultname).
 e2tool_ftab = {