From: Uwe Hermann Date: Tue, 29 May 2012 18:55:22 +0000 (+0200) Subject: cli: Make --protocol-decoder-annotations plural. X-Git-Tag: sigrok-cli-0.3.1~5 X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=commitdiff_plain;h=b6bd032dde74eda6423f13b40e75b9125ad4ce5e;hp=725021fedfa966ec81dab1ca8efbec8721bc0dfc cli: Make --protocol-decoder-annotations plural. This option supports (will support) multiple annotations from multiple PDs, as well as multiple annotation formats per PD, so use plural. --- diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 46e1497..48f02af 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -2,7 +2,7 @@ .SH "NAME" sigrok\-cli \- Command-line client for the sigrok logic analyzer software .SH "SYNOPSIS" -.B sigrok\-cli \fR[\fB\-hVlDdiIoOptwasA\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR decoderlist] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-A\fR|\fB\-\-protocol\-decoder\-annotation\fR annlist] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR] +.B sigrok\-cli \fR[\fB\-hVlDdiIoOptwasA\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR decoderlist] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-A\fR|\fB\-\-protocol\-decoder\-annotations\fR annlist] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR] .SH "DESCRIPTION" .B sigrok\-cli is a cross-platform command line utility for the @@ -271,15 +271,13 @@ option (you cannot specify them in the .B \-s option). .TP -.BR "\-A, \-\-protocol\-decoder\-annotation " +.BR "\-A, \-\-protocol\-decoder\-annotations " By default, only the stack's topmost protocol decoder's annotation output is shown. With this option another decoder's annotation can be selected for display, by specifying its ID: .sp $ -.B "sigrok\-cli \-i \-a i2c,i2cfilter,edid" -.br -.B " \-\-protocol\-decoder\-annotation i2c" +.B "sigrok\-cli \-i \-a i2c,i2cfilter,edid -A i2c" .sp If a protocol decoder has multiple annotation formats, you can also specify which of them to show by specifying its short description like this: @@ -287,7 +285,7 @@ which of them to show by specifying its short description like this: $ .B "sigrok\-cli \-i \-a i2c,i2cfilter,edid" .br -.B " \-\-protocol\-decoder\-annotation i2c=rawhex" +.B " \-A i2c=rawhex" .sp You can also select multiple protocol decoders, with an optional selected annotation format each, by separating them with commas: @@ -295,7 +293,7 @@ annotation format each, by separating them with commas: $ .B "sigrok\-cli \-i \-a i2c,i2cfilter,edid" .br -.B " \-\-protocol\-decoder\-annotation i2c=rawhex,edid" +.B " \-A i2c=rawhex,edid" .TP .BR "\-\-time " Sample for diff --git a/sigrok-cli.c b/sigrok-cli.c index 4ea52cb..03bfbda 100644 --- a/sigrok-cli.c +++ b/sigrok-cli.c @@ -56,7 +56,7 @@ static gchar *opt_probes = NULL; static gchar *opt_triggers = NULL; static gchar *opt_pds = NULL; static gchar *opt_pd_stack = NULL; -static gchar *opt_pd_annotation = NULL; +static gchar *opt_pd_annotations = NULL; static gchar *opt_input_format = NULL; static gchar *opt_output_format = NULL; static gchar *opt_time = NULL; @@ -90,8 +90,8 @@ static GOptionEntry optargs[] = { "Protocol decoders to run", NULL}, {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack, "Protocol decoder stack", NULL}, - {"protocol-decoder-annotation", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotation, - "Protocol decoder annotation to show", NULL}, + {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations, + "Protocol decoder annotation(s) to show", NULL}, {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL}, {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples, @@ -551,8 +551,9 @@ static int register_pds(struct sr_dev *dev, const char *pdstring) * This will be pared down later to leave only the last PD * in the stack. */ - if (!opt_pd_annotation) - g_hash_table_insert(pd_ann_visible, g_strdup(di->inst_id), NULL); + if (!opt_pd_annotations) + g_hash_table_insert(pd_ann_visible, + g_strdup(di->inst_id), NULL); /* Any keys left in the options hash are probes, where the key * is the probe name as specified in the decoder class, and the @@ -615,7 +616,8 @@ int setup_pd_stack(void) * the annotation list was specifically provided). */ if (!opt_pd_annotation) - g_hash_table_remove(pd_ann_visible, di_from->inst_id); + g_hash_table_remove(pd_ann_visible, + di_from->inst_id); di_from = di_to; } @@ -633,8 +635,8 @@ int setup_pd_annotations(void) char **pds, **pdtok, **keyval, **ann_descr; /* Set up custom list of PDs and annotations to show. */ - if (opt_pd_annotation) { - pds = g_strsplit(opt_pd_annotation, ",", 0); + if (opt_pd_annotations) { + pds = g_strsplit(opt_pd_annotations, ",", 0); for (pdtok = pds; *pdtok && **pdtok; pdtok++) { ann = 0; keyval = g_strsplit(*pdtok, "=", 0); @@ -1192,7 +1194,7 @@ int main(int argc, char **argv) if (register_pds(NULL, opt_pds) != 0) return 1; if (srd_pd_output_callback_add(SRD_OUTPUT_ANN, - show_pd_annotation, NULL) != SRD_OK) + show_pd_annotations, NULL) != SRD_OK) return 1; if (setup_pd_stack() != 0) return 1;