Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

utils: Add optional awful.util.deprecate options. 

For now, only a `raw` option is implemented.
This commit is contained in:
Emmanuel Lepage Vallee 2016-12-11 14:51:33 -05:00
parent 81f8a3085e
commit e239492696
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/awful/util.lua
View File

@ -37,7 +37,10 @@ util.shell = os.getenv("SHELL") or "/bin/sh"
local displayed_deprecations = {}
--- Display a deprecation notice, but only once per traceback.
-- @param[opt] see The message to a new method / function to use.
function util.deprecate(see)
-- @tparam table args Extra arguments
-- @tparam boolean args.raw Print the message as-is without the automatic context
function util.deprecate(see, args)
args = args or {}
local tb = debug.traceback()
if displayed_deprecations[tb] then
return
@ -49,7 +52,9 @@ function util.deprecate(see)
local funcname = info.name or "?"
local msg = "awful: function " .. funcname .. " is deprecated"
if see then
if string.sub(see, 1, 3) == 'Use' then
if args.raw then
msg = see
elseif string.sub(see, 1, 3) == 'Use' then
msg = msg .. ". " .. see
else
msg = msg .. ", see " .. see