From 1afb33385870e92cf7b0484710493b2808386cd5 Mon Sep 17 00:00:00 2001 From: patrick96 Date: Sun, 22 Nov 2020 23:18:52 +0100 Subject: [PATCH] doc(actions): Point user to doc when using legacy actions --- doc/user/actions.rst | 12 ++++++------ src/components/controller.cpp | 1 + 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/user/actions.rst b/doc/user/actions.rst index 1f045b7f..cb3581de 100644 --- a/doc/user/actions.rst +++ b/doc/user/actions.rst @@ -241,8 +241,8 @@ custom/menu The data has the form ``N-M`` and the action will execute the command in ``menu-N-M-exec``. -Legacy Action Names -------------------- +Deprecated Action Names +----------------------- .. deprecated:: 3.5.0 @@ -281,7 +281,7 @@ Afterwards build the complete action string as described in Please see :ref:`below ` for an example of migrating a typical menu module. +-------------------------+-----------------------+---------------+ -|Module Type |Legacy Action Name |New Action Name| +|Module Type |Deprecated Action Name |New Action Name| +=========================+=======================+===============+ |``internal/date`` |``datetoggle`` |``toggle`` | +-------------------------+-----------------------+---------------+ @@ -352,9 +352,9 @@ Please see :ref:`below ` for an example of migrating a typical men .. note:: - Some legacy action names are suffixed with ``N``, this means that action has - some additional data (represented by that ``N``), in the new action names, - this data will appear in exactly the same way, after a period. + Some deprecated action names are suffixed with ``N``, this means that that + action has some additional data (represented by that ``N``), in the new + action names this data will appear in exactly the same way, after a period. .. _menu-example: diff --git a/src/components/controller.cpp b/src/components/controller.cpp index 703b2683..3880c91e 100644 --- a/src/components/controller.cpp +++ b/src/components/controller.cpp @@ -479,6 +479,7 @@ bool controller::try_forward_legacy_action(const string& cmd) { } else { m_log.warn("The action '%s' is deprecated, use '#%s.%s.%s' instead!", cmd, module_name, action, data); } + m_log.warn("Consult the 'Actions' page in the polybar documentation for more information."); m_log.info( "Forwarding legacy action '%s' to module '%s' as '%s' with data '%s'", cmd, module_name, action, data); if (!module->input(action, data)) {