doc: update sigrok-cli(1) for channel assignment to decoder inputs
[sigrok-cli.git] / NEWS
bloba431a722ad7c5e317410ed4f879f5c8c78e39031
1 0.7.0 (2017-06-12)
2 ------------------
4  * Update sigrok-cli to the new APIs from both libsigrok 0.5.0 and also
5    libsigrokdecode 0.5.0.
6  * -P <decoder> --show:
7    - List the binary output classes of the decoder.
8    - List the possible input and output IDs of the decoder.
9  * --help:
10    - Clarify that --show also lists input/output format options,
11      as well as protocol decoder options (bug #851).
12    - Show a few typical invocations of e.g. --samples/--time/--continuous.
13  * Add an -L|--list-supported option; this used to be part of -V (bug #604).
14  * Drop the superfluous -S|--protocol-decoder-stack option. Stacking can
15    be done by simply using -P and providing the decoders in the correct order.
16  * Allow multiple -P options to decode multiple stacks (bug #868).
17  * Show decoder instance IDs so the user can tell instances apart (bug #868).
18  * Show annotations based on decoder ID (not instance ID).
19    - Behaviour preserved:
20      Single PD, no -A flag => all annotations from PD
21      Single PD, -A pdid => all annotations from PD
22      Single PD, -A pdid=annX => annX from PD
23    - Behaviour now added:
24      Duplicate PDs, no -A flag => all annotations from all PDs
25      Duplicate PDs, -A pdid => all annotations from all PDs of type pdid
26      Duplicate PDs, -A pdid=annX => all annX from all PDs of type pdid
27  * Fix various memory leaks.
28  * ./configure summary: Show linker flags used.
29  * NSIS:
30    - Update to Python 3.4.x. We can't use any higher version for the time
31      being, since 3.4.x is the last version to support Windows XP.
32    - Place the example .sr files in a separate installer section.
33    - Limit example .sr files to a small set to shrink the installer size.
34    - Clarify Start menu links (e.g. "Uninstall") to avoid confusion.
35  * HACKING: Update URL to Linux kernel coding style.
36  * Fix some compiler warnings (clang).
38 0.6.0 (2016-01-29)
39 ------------------
41  * Update sigrok-cli to the new APIs from both libsigrok 0.4.0 and also
42    libsigrokdecode 0.4.0.
43  * Updated build requirements:
44    - libglib >= 2.32.0
45    - libsigrok >= 0.4.0
46    - libsigrokdecode >= 0.4.0
47  * Fix various compiler errors/warnings.
48  * Check srd_decoder_get_by_id() output to prevent a segfault (bug #370).
49  * manpage: Document the -M and -B options.
50  * Improve option parsing code and make it more robust.
51  * Drop references to obsolete sigrok-commits mailing list.
52  * Properly handle saving logic data packets of any size.
53  * Add 'analog' output module to default output.
54  * Fix various memory leaks.
55  * Show PD annotation row members by name, not number (bug #388).
56  * Handle floating point options for output modules.
57  * If only one non-demo device is present, select it.
58  * Allow input from stdin by specifying "-i -".
59  * Support uint64 input/output module options.
60  * Command line option changes:
61    - Add the --get option.
62    - Add the -T|--transform-module option.
63  * Always save all channels to a session file (bug #410).
64  * Support boolean command line options (bug #450).
65  * NSIS:
66    - Drop libusb0.dll, we always use libusb-1.0 now.
67    - Add start menu entries for Zadig (bug #543).
68    - Install data files into a 'share' subdirectory.
69    - Various additional NSIS file improvements.
70  * Fix a runtime warning with --show (bug #520).
71  * Add "-git-<hash>" suffix to development version numbers.
72  * Fix a libzip-related issue resulting in errors writing .sr files (bug #570).
73  * Fix a unitsize related issue (bug #352).
74  * Add support for SR_T_MQLIST and SR_T_MQ.
75  * Modernize the whole autotools setup.
77 0.5.0 (2014-05-06)
78 ------------------
80  * Update sigrok-cli to the new APIs from both libsigrok 0.3.0 and also
81    libsigrokdecode 0.3.0.
82  * Add support for the new channel groups feature in libsigrok.
83  * Report channel groups (drivers) and annotation rows (PDs) in --show.
84  * The protocol decoder output verbosity now depends on the --loglevel used.
85  * Only show the longest annotation per default if multiple are provided by
86    the PD. Higher numbers for the -l option will show them all.
87  * Allow both hex and decimal numbers as values for command-line options.
88  * Add support for an explicit "sigrok" file format option that can be
89    used with --input-format or --output-format (bug #131).
90  * If no PD annotation class is specified, default to showing all (bug #149).
91  * Fix an issue when running decoders with optional channels (bug #138).
92  * Report possible PD option values in --show output (bug #330).
93  * Allow saving of output in continuous mode (bug #122).
94  * Add support for libsigrok's SR_T_DOUBLE_RANGE config key (bug #335).
95  * Add support for config keys of type G_VARIANT_TYPE_INT32.
96  * Fix a bug which involved trying to save a file containing no data.
97  * Fix an internal probe ordering issue (bug #268).
98  * Fix various memory leak issues (bug #134, others).
99  * Fix a bug causing samplerates in session files being zero (bug #340).
100  * Fix segfault during analog acquisition without '-O analog' (bugs #90, #105).
101  * Fix a compile issue when building without libsigrokdecode (bug #351).
102  * Command line option changes:
103    - Add the -g|--channel-group option.
104    - Add the -M option (for PD meta output type support).
105    - Add the -B option (for PD binary output type support).
106    - Rename the -p|--probes option to -C|--channels.
107  * Various improvements to the NSIS file for better Windows installer support.
108    - Ship (redistributable) firmware files in the Windows installer.
109    - Ship libusb0.dll in the Windows installer (bug #243).
110    - Ship zadig.exe and zadig_xp.exe in the Windows installer.
111    - Ship all sample files from sigrok-dumps in the Windows installer.
112    - Don't ship/run the full Python MSI installer, only the required files.
113    - Fix a working directory issue in the installer.
114  * Build system:
115    - Use a non-recursive automake setup (fewer files, less clutter).
116    - configure output: Show which libs are required and which are optional.
117  * manpage: Various documentation updates.
119 0.4.0 (2013-05-04)
120 ------------------
122  * Update sigrok-cli to the new APIs from both libsigrok 0.2.0 and also
123    libsigrokdecode 0.2.0.
124  * Add support for handling analog data sources (DMMs, scopes, dataloggers).
125  * Bugfix in the handling of -A options with arguments.
126  * Updated build dependencies list.
127    - glib (required): Now must be >= 2.28.0.
128    - libsigrok (required): Now must be >= 0.2.0.
129    - libsigrokdecode (required): Now must be >= 0.2.0.
130  * Add support for specifying input format options.
131  * Probe numbers now generally start at 0 (not 1).
132  * Command line option changes:
133    - The -D|--list-devices option was renamed to --scan.
134    - The -d|--device option was renamed to -c|--config.
135    - The -a|--protocol-decoders option was renamed to -P|--protocol-decoders.
136    - The -s|--protocol-decoder-stack option was renamed to
137      -S|--protocol-decoder-stack.
138    - Added a --driver option to specify which libsigrok driver is to be used.
139    - Added a --show option. This can show details about drivers or PDs.
140    - Added a --frames option which limits the number of frames to get from
141      a supported oscilloscope (or other frame-based device).
142  * Various documentation updates (README, manpage, and so on).
143  * configure: Don't overwrite CFLAGS, but rather amend it.
145 0.3.1 (2012-05-30)
146 ------------------
148  * Add a ChangeLog file to the tarball.
149  * -V option: If "-l 3" or higher is used, the PD description is shown, too.
150  * -a option: Print optional/required PD probes. Example: sigrok-cli -a uart.
151  * Fix compiling with "Homebrew" (Mac OS X).
152  * Stacking order doesn't have to be specified if it's the same as the
153    PD list. Example: sigrok-cli -i <file.sr> -a i2c,edid -s i2c,edid.
154    The -s option is no longer required in this special case.
155  * Only output module or PD output goes to stdout, everything else to stderr.
156  * Improved error handling: Stop sigrok-cli upon various PD related errors.
157  * New -A | --protocol-decoder-annotations option which allows the user to
158    select which annotation types (and from which PD in the stack) to show.
159  * Update the manpage.
160  * Fix a Makefile.am bug which caused the generated ChangeLog files being
161    accidentally deleted upon 'make distclean'.
163 0.3.0 (2012-04-17)
164 ------------------
166  * New major version, now depends on libsigrok and libsigrokdecode.
167  * Initial support for protocol decoders (written in Python >= 3).
168    Supports streaming processing, and stacking of protocol decoders.
169    Currently supported: dcf77, mx25lxx05d, i2s, spi, edid, pan1321, mlx90614,
170    rtc8564, transitioncounter, usb, i2cdemux, i2c, i2cfilter, uart.
171  * Add support for the ChronoVu LA8 logic analyzer.
172  * Add support for the ChronoVu LA8 input- and output-formats.
173  * Add support for the CSV output format.
174  * New CLI options: --loglevel, --input-format, --protocol-decoders, and
175    --protocol-decoder-stack.
176  * Changed CLI options: Rename -f|--format to -O|--output-format.
177  * Demo driver: Add all-low and all-high pattern support.
178  * Saleae Logic driver: Initial support for multiple attached devices.
179  * OLS driver: Run-Length Encoding (RLE) support.
180  * Various portability fixes for Mac OS X and MinGW/Windows.
181  * Many bugfixes, improvements, and documentation updates.
183 0.2.0 (2011-04-03)
184 ------------------
186 This is mostly a bugfix release.
188  * Fix session saving & input file loading, implement session loading support.
189  * Initial work on an NSIS-based Windows installer for sigrok.
190  * CLI: Change syntax for -d and -f to <thing>:key=value:key2=value2.
191  * Various bugfixes, internal code improvements, and documentation updates.
192  * Improve MinGW/Windows support in sigrok, fix various Windows issues.
193  * Improve Openbench Logic Sniffer output format support and add metadata
194    support (requires jawi's OLS client >= 0.9.4-rc1).
195  * Add FreeBSD support for sigrok.
196  * Add initial doxygen support (sigrok API documentation).
197  * ASIX SIGMA: Fix a firmware loading bug.
199 0.1.0 (2011-01-20)
200 ------------------
202  * Initial release.