fdo-mirrors/xorg-xorgproto
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/proto/xorgproto.git synced 2025-12-20 02:20:17 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

keysyms: Add warning about removals & canonical names changes

Browse source
This commit is contained in:
Pierre Le Marre 2024-02-03 18:09:01 +01:00
parent e9a98ce6a7
commit fbd19fa7e5
No known key found for this signature in database
GPG key ID: 3BFB00E5C59E818E
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
include/X11/keysymdef.h
View file

@ -126,6 +126,24 @@ SOFTWARE.
* - the protocol specification in specs/keysyms.xml in this repo
* https://gitlab.freedesktop.org/xorg/proto/xorgproto
*
* Before removing or changing the order of the keysyms, please consider
* the following: it is very difficult to know what keysyms are used and
* how.
*
* - A sandboxed application may have incompatibilities with the host
* system. For example, if new keysym name is introduced and is made
* the canonical name, then an application with an older keysym parser
* will not be able to parse the new name.
* - Customization of keyboard layout and Compose files are two popular
* use cases. Checking the standard keyboard layout database xkeyboard-config
* https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config
* and the standard Compose files in libx11
* https://gitlab.freedesktop.org/xorg/lib/libx11 is a mandatory
* step, but may *not* be enough for a proper impact assessment for
* e.g. keysyms removals.
*
* Therefore, it is advised to proceed to no removal and to make a new
* name canonical only 10 years after its introduction.
*/
#define XK_VoidSymbol 0xffffff /* Void symbol */