summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2023-10-31 14:00:22 +0100
committerJonas Bernoulli <jonas@bernoul.li>2023-10-31 14:00:22 +0100
commit2eb214a6ecbd632760706de9056441fb581ec5fa (patch)
tree396043b7e67fa554ee923857690be6139f1e3584 /docs
parented5bd6fdc38dc586793315dff1be5c1643c96b4c (diff)
transient-infix-set(argument): Also disable based on concrete value
"--one" may be incompatible with "--two=foo" but not "--two=bar".
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org7
-rw-r--r--docs/transient.texi9
2 files changed, 13 insertions, 3 deletions
diff --git a/docs/transient.org b/docs/transient.org
index 7f3ccf2..e8b5a6c 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -1792,7 +1792,12 @@ functions use ~describe-function~.
- ~incompatible~ A list of lists. Each sub-list specifies a set of
mutually exclusive arguments. Enabling one of these arguments
causes the others to be disabled. An argument may appear in
- multiple sub-lists.
+ multiple sub-lists. Arguments must me given in the same form as
+ used in the ~argument~ or ~argument-format~ slot of the respective
+ suffix objects, usually something like ~--switch~ or ~--option=%s~. For
+ options and ~transient-switches~ suffixes it is also possible to match
+ against a specific value, as returned by ~transient-infix-value~,
+ for example, ~--option=one~.
- ~scope~ For some transients it might be necessary to have a sort of
secondary value, called a “scope”. See ~transient-define-prefix~.
diff --git a/docs/transient.texi b/docs/transient.texi
index 873e2e8..a8d1ab2 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -2033,11 +2033,16 @@ disabled by default and still considered experimental.
@code{incompatible} A list of lists. Each sub-list specifies a set of
mutually exclusive arguments. Enabling one of these arguments
causes the others to be disabled. An argument may appear in
-multiple sub-lists.
+multiple sub-lists. Arguments must me given in the same form as
+used in the @code{argument} or @code{argument-format} slot of the respective
+suffix objects, usually something like @code{--switch} or @code{--option=%s}. For
+options and @code{transient-switches} suffixes it is also possible to match
+against a specific value, as returned by @code{transient-infix-value},
+for example, @code{--option=one}.
@item
@code{scope} For some transients it might be necessary to have a sort of
-secondary value, called a ``scope''. See @code{transient-define-prefix}.
+secondary value, called a “scope”. See @code{transient-define-prefix}.
@end itemize
@anchor{Internal Prefix Slots}