docs: update the include path documentation
authorPeter Hutterer <peter.hutterer@who-t.net>
Wed, 13 Nov 2019 23:52:21 +0000 (09:52 +1000)
committerRan Benita <ran234@gmail.com>
Thu, 14 Nov 2019 08:17:46 +0000 (10:17 +0200)
Missing from e23f1061b2b9c8d40ba7797a5ffbd6d474d604e0 and
3a91788d9254b4571ff883439931f497d8a0663f.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
xkbcommon/xkbcommon.h

index 4576330..559d5d7 100644 (file)
@@ -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.
  *
  * @{
  */