help: list all commands that match string
[fw/openocd] / NEWS
diff --git a/NEWS b/NEWS
index f56c7a4f38342d5790b64d1862ef700a4db633c5..e122912264d09ed222f0492644957469af610dc3 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,79 +1,77 @@
-The OpenOCD 0.2.0 source archive release includes numerous improvements
-that were made since the initial 0.1.0 source archive release.  Many
-contributors helped make this release a great success, and the community
-of developers and maintainers look forward to any response.
-
-In addition to the list of changes below, countless bug fixing and
-cleaning was performed across the tree.  Various TCL command parameters
-must past stricter value checks, and many more error conditions have
-been handled correctly.  These efforts helped to make the 0.2.0 release
-more stable and robust, though some changes may expose latent bugs in
-your existing configuration scripts.
-This release does not maintain backward compatibility in all respects,
-so some target or configuration scripts may need to be updated.  In some
-cases, you may also see warnings; resolve those, because they indicate
-commands that will be removed in the future.
-
-The following areas of OpenOCD functionality changed in this release:
+This file includes highlights of the changes made in the
+OpenOCD 0.4.0 source archive release.  See the repository
+history for details about what changed, including bugfixes
+and other issues not mentioned here.
 
 JTAG Layer:
-- Improves modularity: core, TCL, driver commands, and interface have
-  been separated, encapsulated, and documented for developers.  Mostly.
-- Improves JTAG TAP transition tables: 
-   * Makes TAP paths variable length, rather than being fixed at 7 steps.
-   * Fixes problems with some targets that did not like longer paths.
-- Improves JTAG driver/minidriver modularity and encapsulation.
-- New drivers:
-   * Adds stub minidriver for developing new embedded JTAG interfaces.
-- Improves drivers:
-   * ft2232+ftd2xx:
-      + Adds initial high-speed device support: --enable-ftd2xx-highspeed
-      + Supports more types of FTDI-based devices.
-   * jlink:
-      + Works with more versions of the firmware (v3 and newer)
-      + Supports dynamically detects device capabilities and limits
-   * vsllink:
-      + Supports very long scan chains
-   * amtjtagaccel:
-      + Fixes broken ID code detection problems.
+       Support KT-Link JTAG adapter.
 
+Boundary Scan:
 Target Layer:
-- New devices: AVR, FA526
-- Improved support: ARM ADI, ARM11, MIPS
-- Numerous other bug fixes and improvements
+       General
+               - new "reset-assert" event, for systems without SRST
+       ARM
+               - renamed "armv4_5" command prefix as "arm"
+               - recognize TrustZone "Secure Monitor" mode
+               - "arm regs" command output changed
+               - register names use "sp" not "r13"
+               - add top-level "mcr" and "mrc" commands, replacing
+                 various core-specific operations
+               - basic semihosting support
+       ARM11
+               - Preliminary ETM and ETB hookup
+               - accelerated "flash erase_check"
+               - accelerated GDB memory checksum
+               - support "arm regs" command
+               - can access all core modes and registers
+               - watchpoint support
+       Cortex-A8
+               - support "arm regs" command
+               - can access all core modes and registers
+               - supports "reset-assert" event (used on OMAP3530)
+               - watchpoint support
+       Cortex-M3
+               - Exposed DWT registers like cycle counter
+       ETM, ETB
+               - "trigger_percent" command moved ETM --> ETB
+               - "etm trigger_debug" command added
 
 Flash Layer:
-- Improved drivers: mflash
-- New drivers: AT91SAM3, AVR, Davinci NAND
+       'flash bank' and 'nand device' take <bank_name> as first argument.
+       With this, flash/NAND commands allow referencing banks by name:
+               - <bank_name>: reference the bank with its defined name
+               - <driver_name>[.N]: reference the driver's Nth bank
+       New 'nand verify' command to check bank against an image file.
+       The "flash erase_address" command now rejects partial sectors;
+               previously it would silently erase extra data.
 
-Board, Interface, and Target Configuration Scripts:
-- Many new and improved targets and boards are now available.
-- Better separation of "board" and "target" configuration
-- Moved all TCL files to top-level "tcl" directory in the source tree
-- Installation moved from '$pkglibdir/' to '$pkgdatadir/scripts/'.
-- Site-specific files should be installed under '$pkgdatadir/site/';
-  files that exist this tree will be used in preference to default
-  distribution configurations in '$pkgdatadir/scripts/'.
+Board, Target, and Interface Configuration Scripts:
+       ARM9
+               - ETM and ETB hookup for iMX2* targets
+       Add $HOME/.openocd to the search path.
+
+Core Jim/TCL Scripting:
+       New 'usage' command to provide terse command help.
+       Improved command 'help' command output (sorted and indented).
+       Improved command handling:
+               - Most boolean settings now accept any of the following:
+                 on/off, enable/disable, true/false, yes/no, 1/0
+               - More error checking and reporting.
 
 Documentation:
-- Updated User Guide:     http://openocd.berlios.de/doc/html/index.html
-   * Partially re-written and re-organized.
-   * Standardized presentation for all commands.
-   * Covers many drivers and commands that were previously omitted.
-   * New index for commands and drivers.
-- Added Developer Manual: http://openocd.berlios.de/doc/doxygen/index.html
-   * Now includes architecture, technical primers, style guides, and more.
-   * Available in-tree and on-line.
+       New built-in command development documentation and primer.
 
 Build and Release:
-- Increased configuration and compilation warning coverage.
-   * Use --disable-werror to work around build errors caused by warnings.
-- Use libtool to produce helper libraries as a step toward "libopenocd".
-- New processes and scripting to facilitate future source releases.
+       Use --enable-doxygen-pdf to build PDF developer documentation.
+       Consider upgrading to libftdi 0.17 if you use that library; it
+               includes bugfixes which improve FT2232H support.
+
+For more details about what has changed since the last release,
+see the git repository history.  With gitweb, you can browse that
+in various levels of detail.
 
-For more details about what has changed since 0.1.0, see the ChangeLog
-associated with this release.
+For older NEWS, see the NEWS files associated with each release
+(i.e. NEWS-<version>).
 
 For more information about contributing test reports, bug fixes, or new
 features and device support, please read the new Developer Manual (or