From 85701e003241798e36b81ed1e3ed285f7bf5c7a0 Mon Sep 17 00:00:00 2001 From: Peter Melnichenko Date: Mon, 11 Sep 2017 13:19:03 +0300 Subject: Clarify test_env.need_rock description wrt return value --- test/test_environment.lua | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'test') diff --git a/test/test_environment.lua b/test/test_environment.lua index c781af4b..bc1e5277 100644 --- a/test/test_environment.lua +++ b/test/test_environment.lua @@ -533,7 +533,9 @@ function test_env.setup_specs(extra_rocks) end end ---- Test if required rock is installed if not, install it +--- Test if required rock is installed and if not, install it. +-- Return `true` if the rock is already installed or has been installed successfully, +-- `false` if installation failed. function test_env.need_rock(rock) print("Check if " .. rock .. " is installed") if test_env.run.luarocks_noprint_nocov(test_env.quiet("show " .. rock)) then -- cgit v1.2.3-55-g6feb