summaryrefslogtreecommitdiff
path: root/xkbcommon
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2019-11-14 09:52:21 +1000
committerRan Benita <ran234@gmail.com>2019-11-14 10:17:46 +0200
commit59d2a71383e38d0a1ef1811d25d5d5f7518d9090 (patch)
treeb4cb08f7e15fc93b7d63acfdbaa8c2e8ba2fc491 /xkbcommon
parent3d43f4806d30461bba671e514e9b8a52d732ee20 (diff)
downloadxorg-lib-libxkbcommon-59d2a71383e38d0a1ef1811d25d5d5f7518d9090.tar.gz
docs: update the include path documentation
Missing from e23f1061b2b9c8d40ba7797a5ffbd6d474d604e0 and 3a91788d9254b4571ff883439931f497d8a0663f. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'xkbcommon')
-rw-r--r--xkbcommon/xkbcommon.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h
index 4576330..559d5d7 100644
--- a/xkbcommon/xkbcommon.h
+++ b/xkbcommon/xkbcommon.h
@@ -616,11 +616,13 @@ xkb_context_get_user_data(struct xkb_context *context);
* The include paths are the file-system paths that are searched when an
* include statement is encountered during keymap compilation.
*
- * The default include paths are:
- * - The system XKB root, defined at library configuration time.
- * If * the `XKB_CONFIG_ROOT` environment is defined, it is used instead.
+ * The default include paths are, in that lookup order:
+ * - The path `$XDG_CONFIG_HOME/xkb`, with the usual `XDG_CONFIG_HOME`
+ * fallback to `$HOME/.config/` if unset.
* - The path `$HOME/.xkb`, where $HOME is the value of the environment
* variable `HOME`.
+ * - The `XKB_CONFIG_ROOT` environment variable, if defined, otherwise
+ * the system XKB root, defined at library configuration time.
*
* @{
*/