NEWS

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