diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2020-08-26 15:47:51 +1000 |
|---|---|---|
| committer | Ran Benita <ran@unusedvar.com> | 2020-08-30 21:49:41 +0300 |
| commit | ae90a6a0a9f94c930d96453d1c829ccbf806aaf7 (patch) | |
| tree | fb280e761cb3aebd5e1ba5e831bd1d20a135232a | |
| parent | d00cf64dbc586a1052e1f0d0e7f1a48bbff293ec (diff) | |
| download | libxkbcommon-ae90a6a0a9f94c930d96453d1c829ccbf806aaf7.tar.gz libxkbcommon-ae90a6a0a9f94c930d96453d1c829ccbf806aaf7.tar.bz2 libxkbcommon-ae90a6a0a9f94c930d96453d1c829ccbf806aaf7.zip | |
doc: add some disclaimer regarding user-specific key types and compat entries
It's a niche use-case but basically the same as adding symbols, so let's go with
a general handwavy explanation.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
| -rw-r--r-- | doc/user-configuration.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/user-configuration.md b/doc/user-configuration.md index b8c4d30..2146599 100644 --- a/doc/user-configuration.md +++ b/doc/user-configuration.md @@ -31,6 +31,15 @@ Each directory should have one or more of the following subdirectories: - `symbols` - `types` +The majority of user-specific configuration involve modifying key symbols and +this is what this document focuses on. For use-cases where a user may need to +add new key types or compat entries the general approach remains the same. A +detailed description for how to add those types or compat entries is out of +scope for this document. + +You should never need to add user-specific keycodes. Where a keycode is missing, +the addition should be filed in the upstream xkeyboard-config project. + ## RMLVO vs KcCGST Due to how XKB is configured, there is no such thing as a "layout" in XKB |