From: Gerhard Sittig <redacted>
Date: Wed, 10 Oct 2018 08:13:51 +0000 (+0200)
Subject: doc: mention lack of decoder signal name matching in manpage
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=65f903f911c08beefb1573c54cbadf821f5ce1f3;p=sigrok-cli.git

doc: mention lack of decoder signal name matching in manpage

Users may assume that sigrok-cli automatically matches input trace names
to decoder signals like pulseview does, and not be able to learn that
this is not the case. Explicitly state that limitation in the manpage.
---

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index 8fbb3a1..eac5942 100644
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -229,6 +229,12 @@ is an option supported by the
 protocol decoder. Additionally, the user tells sigrok to decode the SPI
 protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3
 as CLK, and channel 0 as CS# signal.
+.sp
+Notice that the
+.B sigrok\-cli
+application does not support "name matching". Instead it's assumed that the
+traces in the input stream match the order of the decoder's input signals,
+or that users explicitly specify the input channel to decoder signal mapping.
 .br
 .sp
 When multiple decoders are specified in the same