From: Gerhard Sittig <redacted>
Date: Thu, 11 Apr 2019 18:34:34 +0000 (+0200)
Subject: doc: weaken and extend the description of the -d option
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=77525a84a5ffc19ca0ff2989dc787d0c257248da;p=sigrok-cli.git

doc: weaken and extend the description of the -d option

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.
---

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index e5562c1..bda6cf3 100644
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -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