doc: weaken and extend the description of the -d option
authorGerhard Sittig <gerhard.sittig@gmx.net>
Thu, 11 Apr 2019 18:34:34 +0000 (20:34 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Tue, 14 May 2019 18:06:07 +0000 (20:06 +0200)
The software implementation supports automatic driver scans, while the
manpage claimed that -d was mandatory. Change the description, suggest
to specify -d for various reasons, but "allow" for the absence of the -d
option as well.

doc/sigrok-cli.1

index e5562c19043d6e3174c4ef93d8d258cf2d3fee62..bda6cf3a05ff948d1efa74d4827edbb94ffb2cc2 100644 (file)
@@ -34,7 +34,10 @@ This is generally only used by developers to easily update the list of
 supported protocol decoders in the sigrok wiki.
 .TP
 \fB\-d, \-\-driver\fP <drivername>
-A driver must always be selected (unless doing a global scan). Use the
+Unless doing a global scan, users typically select one of the available
+drivers. This can speedup program start, and can avoid false matches for
+ambiguous configurations. Selecting a driver also allows to pass more
+driver specific options. Use the
 .BR "\-L " ( "\-\-list\-supported" ")"
 option to get a list of available drivers.
 .sp