@gnu-mcu-eclipse/openocd

The GNU MCU Eclipse OpenOCD binary xPack

This binary xPack installs the platform specific binaries for the GNU MCU Eclipse OpenOCD.

The source files of the xPack project are publicly available from GitHub.

How to use

This section is intended for developers who plan to use the OpenOCD binaries.

Prerequisites

The only requirement is a recent xpm, which is a portable Node.js command line application. To install it, follow the instructions from the xpm page.

Easy install

The xPack is available as @gnu-mcu-eclipse/openocd from the npmjs.com repository; with xpm available, installing the latest version of the package is quite easy:

$ xpm install --global @gnu-mcu-eclipse/openocd

Global xPacks are always installed in the user home folder, even on GNU/Linux
or macOS, and do not require sudo.

The GNU MCU Eclipse plug-ins automatically identify binaries installed with xpm and provide a convenient method to manage paths.

To remove the installed xPack, the command is similar:

$ xpm uninstall --global @gnu-mcu-eclipse/openocd

(Note: not yet implemented. As a temporary workaround, simply remove the xPacks/@gnu-mcu-eclipse/openocd folder, or the versions subfolders.)

Developer info

The xPack git repo

The few xPack source files are available from GitHub:

$ git clone https://github.com/gnu-mcu-eclipse/openocd-xpack.git openocd-xpack.git

Binary files

The binaries are not stored on the npmjs.com server, but are downloaded from
the releases section of the gnu-mcu-eclipse/openocd GitHub project.

Maintainer info

How to publish

open releases and select the latest release
update the baseUrl: with the file URLs (including the tag/version)
from the blog post, copy the SHA & file names
commit all changes, use a message like package.json: update urls for 0.10.0-5.1 release (without v)
update CHANGELOG.md; commit with a message like CHANGELOG: prepare v0.10.0-5.1
npm version 0.10.0-5.1
push all changes to GitHub
npm publish

License

The binary distributions include several open-source components; the corresponding licenses are available in the gnu-mcu-eclipse/licenses folder.