From: Tobias Ulmer <tu@emlix.com>
Date: Mon, 22 Jan 2018 17:29:26 +0000 (+0100)
Subject: policy: document handle_commandline_options
X-Git-Tag: e2factory-2.3.18rc1~80
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=f90a45cd245074d1b0dd83ffda7ec9b7ae491d00;p=e2factory.git

policy: document handle_commandline_options
---

diff --git a/local/policy.lua b/local/policy.lua
index 6ff17be..cd32a64 100644
--- a/local/policy.lua
+++ b/local/policy.lua
@@ -202,8 +202,15 @@ function policy.register_commandline_options()
     Enabled by default in 'release' mode.]])
 end
 
----
+--- Handle overall build modes.
+-- @param opts e2option table.
+-- @param use_default Use default build mode if none is specified.
+-- @return mode table or false on error.
+-- @return Error on failure.
 function policy.handle_commandline_options(opts, use_default)
+    assertIsTable(opts)
+    assertIsBoolean(use_default)
+
     local default_build_mode_name = "tag"
     local nmodes = 0
     local mode = false