decodetree: Document the usefulness of argument sets
authorRichard Henderson <richard.henderson@linaro.org>
Thu, 28 Feb 2019 02:34:38 +0000 (18:34 -0800)
committerRichard Henderson <richard.henderson@linaro.org>
Tue, 12 Mar 2019 16:46:58 +0000 (09:46 -0700)
Reviewed-by: Bastian Koppelmann <kbastian@mail.uni-paderborn.de>
Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
docs/devel/decodetree.rst

index d9be30b2dbd44a164425e6b730e57c4a917eed39..62cb7f687c226711feead5f3498a8c22c83845e4 100644 (file)
@@ -69,6 +69,13 @@ with each of the fields being one of the member arguments.
 If ``!extern`` is specified, the backing structure is assumed
 to have been already declared, typically via a second decoder.
 
+Argument sets are useful when one wants to define helper functions
+for the translator functions that can perform operations on a common
+set of arguments.  This can ensure, for instance, that the ``AND``
+pattern and the ``OR`` pattern put their operands into the same named
+structure, so that a common ``gen_logic_insn`` may be able to handle
+the operations common between the two.
+
 Argument set examples::
 
   &reg3       ra rb rc