]> sigrok.org Git - libsigrok.git/commit
input/csv: rework user accessible options for consistency
authorGerhard Sittig <redacted>
Wed, 16 Oct 2019 18:40:36 +0000 (20:40 +0200)
committerGerhard Sittig <redacted>
Sat, 21 Dec 2019 17:20:04 +0000 (18:20 +0100)
commit72903e9d5546c5b2a012007040920a34acac921e
tree4ffdebffc41ce24b9555b21d2e221784e806b10c
parent1a920e33fefffe474a8949fccb9f604dfef8401b
input/csv: rework user accessible options for consistency

Rename the CSV input module's option keywords. To better reflect their
purpose, and for consistency across the rather complex set of options
and how they interact. Rearrange the list of options (not that the order
matters from the outside, but it's good to have during maintenance).

Update builtin help texts which will show up in applications, as well as
the source code comments which discuss these options in greater detail.
Would be nice to have a "general" help text for input modules which is
not tied to one single option, to provide an overview or use examples.
Arrange the option keys, short and long help texts such that the source
better reflects the applications' screen layout. To better support
future maintenance, again.

Consistently separate multi-work keywords for improved readability.
Prefer underscores over dashes for consistency with common keys in
shared infrastructure in other project sources (device options, MQ
items, etc).
src/input/csv.c