summaryrefslogtreecommitdiffstats
path: root/Documentation/input
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-04-04 17:47:00 -0700
committerDmitry Torokhov <dmitry.torokhov@gmail.com>2017-04-05 15:45:00 -0700
commit2f438935561cc24caf839a9fb07f4ee51b8acd2f (patch)
tree745a1e948c4c848267b15050f508eca7abd7c8bf /Documentation/input
parenteba31a3af9707bf5445f6d46fb7bff35086f16d3 (diff)
downloadlinux-stable-2f438935561cc24caf839a9fb07f4ee51b8acd2f.tar.gz
linux-stable-2f438935561cc24caf839a9fb07f4ee51b8acd2f.tar.bz2
linux-stable-2f438935561cc24caf839a9fb07f4ee51b8acd2f.zip
Input: convert keyboard notifier docs into ReST format
This file require minimum adjustments to be a valid ReST file. Do it, in order to be able to parse it with Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Diffstat (limited to 'Documentation/input')
-rw-r--r--Documentation/input/notifier.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/input/notifier.txt b/Documentation/input/notifier.txt
index 95172ca6f3d2..161350cb865e 100644
--- a/Documentation/input/notifier.txt
+++ b/Documentation/input/notifier.txt
@@ -1,4 +1,6 @@
+=================
Keyboard notifier
+=================
One can use register_keyboard_notifier to get called back on keyboard
events (see kbd_keycode() function for details). The passed structure is
@@ -23,9 +25,9 @@ For each kind of event but the last, the callback may return NOTIFY_STOP in
order to "eat" the event: the notify loop is stopped and the keyboard event is
dropped.
-In a rough C snippet, we have:
+In a rough C snippet, we have::
-kbd_keycode(keycode) {
+ kbd_keycode(keycode) {
...
params.value = keycode;
if (notifier_call_chain(KBD_KEYCODE,&params) == NOTIFY_STOP)
@@ -47,6 +49,6 @@ kbd_keycode(keycode) {
return;
apply keysym;
notifier_call_chain(KBD_POST_KEYSYM,&params);
-}
+ }
-NOTE: This notifier is usually called from interrupt context.
+.. note:: This notifier is usually called from interrupt context.