From 7bc51781397394d8b5a0cdd46b6f3affd3f5f8af Mon Sep 17 00:00:00 2001 From: Pierre Le Marre Date: Wed, 19 Jul 2023 18:50:20 +0200 Subject: keysymdef.h: Improve doc on deprecated keysyms MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The documentation on deprecated keysyms lacks precision for two cases, which are fixed by this commit: - Explicit aliases (comment: “alias for XXX”) are not deprecated. - A keysym can be explicitly deprecated by starting its comment with “deprecated”. --- include/X11/keysymdef.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'include') diff --git a/include/X11/keysymdef.h b/include/X11/keysymdef.h index 118290d..d920e5b 100644 --- a/include/X11/keysymdef.h +++ b/include/X11/keysymdef.h @@ -81,8 +81,15 @@ SOFTWARE. * existing legacy keysym values in the range 0x0100 to 0x20ff. * * Where several mnemonic names are defined for the same keysym in this - * file, all but the first one listed should be considered deprecated. + * file, all but the first one listed should be considered deprecated, + * unless the comment explicitly states the alias, e.g.: + * + * #define XK_dead_tilde 0xfe53 + * #define XK_dead_perispomeni 0xfe53 // alias for dead_tilde * + * Additionally, a keysym can be explicitly deprecated by starting the + * comment with "deprecated". + * * Mnemonic names for keysyms are defined in this file with lines * that match one of these Perl regular expressions: * -- cgit v1.2.3