From 67b12579d9386196ab6532aa99a2374de2a613a1 Mon Sep 17 00:00:00 2001
From: Uli Schlachter <psychon@znc.in>
Date: Fri, 3 Mar 2017 17:20:56 +0100
Subject: [PATCH] Deprecate menubar.get()

The function seems useless and its documentation is wrong. It does not
return a wibox, but a widget. Also, the widget cannot really be used on
its own since it depends on the size of the wibox.

So menubar.get() and its wrapper through the metatable __call should
just be removed. Until then, the needed initialisation code is moved
around a bit and the function is deprecated.

Signed-off-by: Uli Schlachter <psychon@znc.in>
---
 lib/menubar/init.lua | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/lib/menubar/init.lua b/lib/menubar/init.lua
index 1a7514cf..87dfcef0 100644
--- a/lib/menubar/init.lua
+++ b/lib/menubar/init.lua
@@ -35,7 +35,7 @@ local function get_screen(s)
 end
 
 -- menubar
-local menubar = { mt = {}, menu_entries = {} }
+local menubar = { menu_entries = {} }
 menubar.menu_gen = require("menubar.menu_gen")
 menubar.utils = require("menubar.utils")
 local compute_text_width = menubar.utils.compute_text_width
@@ -388,9 +388,15 @@ end
 -- @param scr Screen.
 function menubar.show(scr)
     if not instance then
+        menubar.refresh(scr)
+        -- Add to each category the name of its key in all_categories
+        for k, v in pairs(menubar.menu_gen.all_categories) do
+            v.key = k
+        end
+
         instance = {
             wibox = wibox({ ontop = true }),
-            widget = menubar.get(scr),
+            widget = common_args.w,
             prompt = awful.widget.prompt(),
             query = nil,
             count_table = nil,
@@ -451,7 +457,9 @@ end
 --- Get a menubar wibox.
 -- @tparam[opt] screen scr Screen.
 -- @return menubar wibox.
+-- @deprecated If you know what this actually does, please tell us
 function menubar.get(scr)
+    awful.util.deprecate("Use menubar.show() instead", { deprecated_in = 5 })
     menubar.refresh(scr)
     -- Add to each category the name of its key in all_categories
     for k, v in pairs(menubar.menu_gen.all_categories) do
@@ -460,10 +468,11 @@ function menubar.get(scr)
     return common_args.w
 end
 
-function menubar.mt.__call(_, ...)
+local mt = {}
+function mt.__call(_, ...)
     return menubar.get(...)
 end
 
-return setmetatable(menubar, menubar.mt)
+return setmetatable(menubar, mt)
 
 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80