doc: add note on variants in rule names

Fixes: https://github.com/xkbcommon/libxkbcommon/issues/208 Signed-off-by: Ran Benita <ran@unusedvar.com>
2021-02-27 22:12:08 +02:00 · 2021-02-27 22:12:08 +02:00 · afc5370c86
parent 30ce6c04f9
commit afc5370c86
1 changed files with 3 additions and 0 deletions
--- a/xkbcommon/xkbcommon.h
+++ b/xkbcommon/xkbcommon.h
@ -355,6 +355,9 @@ struct xkb_rule_names {
     * A comma separated list of variants, one per layout, which may
     * modify or augment the respective layout in various ways.
     *
+     * Generally, should either be empty or have the same number of values
+     * as the number of layouts. You may use empty values as in "intl,,neo".
+     *
     * If NULL or the empty string "", and a default value is also used
     * for the layout, a default value is used.  Otherwise no variant is
     * used.