Clarify that easy-menu-add is a nop (Bug#25382)

* lisp/emacs-lisp/easymenu.el (easy-menu-add): Make it into an alias of
`ignore', like `easy-menu-remove'.
This commit is contained in:
Noam Postavsky 2017-01-07 09:26:08 -05:00
parent 3c69f2c5bb
commit b0ade0df21

View file

@ -489,7 +489,7 @@ To implement dynamic menus, either call this from
;; XEmacs needs the following two functions to add and remove menus. ;; XEmacs needs the following two functions to add and remove menus.
;; In Emacs this is done automatically when switching keymaps, so ;; In Emacs this is done automatically when switching keymaps, so
;; here easy-menu-remove is a noop. ;; here easy-menu-remove and easy-menu-add are a noops.
(defalias 'easy-menu-remove 'ignore (defalias 'easy-menu-remove 'ignore
"Remove MENU from the current menu bar. "Remove MENU from the current menu bar.
Contrary to XEmacs, this is a nop on Emacs since menus are automatically Contrary to XEmacs, this is a nop on Emacs since menus are automatically
@ -497,15 +497,16 @@ Contrary to XEmacs, this is a nop on Emacs since menus are automatically
\(fn MENU)") \(fn MENU)")
(defun easy-menu-add (_menu &optional _map) (defalias 'easy-menu-add #'ignore
"Add the menu to the menubar. "Add the menu to the menubar.
On Emacs, menus are already automatically activated when the On Emacs this is a nop, because menus are already automatically
corresponding keymap is activated. On XEmacs this is needed to activated when the corresponding keymap is activated. On XEmacs
actually add the menu to the current menubar. this is needed to actually add the menu to the current menubar.
You should call this once the menu and keybindings are set up You should call this once the menu and keybindings are set up
completely and menu filter functions can be expected to work." completely and menu filter functions can be expected to work.
)
\(fn MENU &optional MAP)")
(defun add-submenu (menu-path submenu &optional before in-menu) (defun add-submenu (menu-path submenu &optional before in-menu)
"Add submenu SUBMENU in the menu at MENU-PATH. "Add submenu SUBMENU in the menu at MENU-PATH.