From 02a676a817f11472679b2bf9f3aefdcfa597bfad Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Fri, 16 Aug 2024 23:33:20 +0300 Subject: [PATCH] website: re-generate workflows --- ...01-19-openocd-v0.8.0-20150119-released.mdx | 2 +- ...01-31-openocd-v0.8.0-20150131-released.mdx | 2 +- ...03-20-openocd-v0.8.0-20150320-released.mdx | 2 +- ...03-20-openocd-v0.9.0-20150320-released.mdx | 2 +- ...03-24-openocd-v0.8.0-20150324-released.mdx | 2 +- ...4-openocd-v0.9.0-20150324-dev-released.mdx | 2 +- ...05-19-openocd-v0.9.0-20150519-released.mdx | 2 +- ...-openocd-v0.10.0-20151028-dev-released.mdx | 4 +- ...nocd-v0.10.0-201601101000-dev-released.mdx | 4 +- ...-openocd-v0-10-0-20161028-dev-released.mdx | 4 +- ...1-24-openocd-v0-10-0-20170124-released.mdx | 4 +- ...4-18-openocd-v0-10-0-20170418-released.mdx | 4 +- ...penocd-v0-10-0-3-20170826-dev-released.mdx | 2 +- ...penocd-v0-10-0-4-20171004-dev-released.mdx | 2 +- ...10-openocd-v0-10-0-5-20171110-released.mdx | 2 +- ...12-openocd-v0-10-0-6-20180112-released.mdx | 2 +- ...23-openocd-v0-10-0-7-20180123-released.mdx | 2 +- ...12-openocd-v0-10-0-8-20180512-released.mdx | 2 +- ...16-openocd-v0-10-0-9-20181016-released.mdx | 2 +- ...0-openocd-v0-10-0-10-20181020-released.mdx | 2 +- ...8-openocd-v0-10-0-11-20190118-released.mdx | 2 +- ...2-openocd-v0-10-0-12-20190422-released.mdx | 2 +- ...2019-07-17-openocd-v0-10-0-13-released.mdx | 4 +- ...2020-06-26-openocd-v0-10-0-14-released.mdx | 8 +- ...2020-10-13-openocd-v0-10-0-15-released.mdx | 8 +- .../2021-03-15-openocd-v0-11-0-1-released.mdx | 8 +- .../2021-10-16-openocd-v0-11-0-2-released.mdx | 12 +- .../2021-12-07-openocd-v0-11-0-3-released.mdx | 12 +- .../2022-03-25-openocd-v0-11-0-4-released.mdx | 25 +-- .../2022-09-01-openocd-v0-11-0-5-released.mdx | 25 +-- .../2023-01-30-openocd-v0-12-0-1-released.mdx | 25 +-- .../2023-09-04-openocd-v0-12-0-2-released.mdx | 25 +-- .../2024-04-02-openocd-v0-12-0-3-released.mdx | 25 +-- website/blog/_common/_download-analytics.mdx | 4 +- .../_common/_platform-docker-section.mdx | 34 +-- .../_common/_platform-native-section.mdx | 30 +-- website/docs/developer/index.mdx | 12 +- .../_common/_gcc-release-schedule.mdx | 8 +- website/docs/getting-started/index.mdx | 10 +- .../_common/_automatic-install-quick-test.mdx | 24 +- .../_common/_manual-install-quick-test.mdx | 24 +- website/docs/install/index.mdx | 102 +++++---- .../_arm-toolchain-check-upstream-release.mdx | 36 +++ ..._arm-toolchain-update-version-specific.mdx | 54 +++++ .../_common/_platform-docker-build.mdx | 42 ++-- .../_common/_platform-native-build.mdx | 40 ++-- .../maintainer/_first-development-run.mdx | 2 + .../docs/maintainer/_first-production-run.mdx | 2 + website/docs/maintainer/index.mdx | 212 +++++++++++------- website/docs/releases/index.md | 2 +- website/docs/support/index.mdx | 12 +- website/docs/test/index.mdx | 4 +- .../_common/_arm-toolchain-versioning.mdx | 40 ++++ website/docs/user/_common/_versioning.mdx | 12 +- website/docusaurus.config.ts | 21 +- .../src/components/HomepageFeatures/index.tsx | 4 +- .../src/components/InstallWithCopy/index.tsx | 2 +- website/src/components/ReleasesList/index.tsx | 6 +- website/src/libs/isXpackSubversionDouble.js | 19 ++ website/src/libs/versionMajor.js | 1 + website/src/libs/versionMinor.js | 21 ++ website/src/pages/index.tsx | 4 +- website/src/plugins/SelectReleasesPlugin.js | 2 +- website/static/img/check-badge.svg | 6 +- website/static/img/globe.svg | 10 +- website/static/img/mosaic.svg | 10 +- 66 files changed, 668 insertions(+), 375 deletions(-) create mode 100644 website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx create mode 100644 website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx create mode 100644 website/docs/maintainer/_first-development-run.mdx create mode 100644 website/docs/maintainer/_first-production-run.mdx create mode 100644 website/docs/user/_common/_arm-toolchain-versioning.mdx create mode 100644 website/src/libs/isXpackSubversionDouble.js create mode 100644 website/src/libs/versionMinor.js diff --git a/website/blog/2015-01-19-openocd-v0.8.0-20150119-released.mdx b/website/blog/2015-01-19-openocd-v0.8.0-20150119-released.mdx index 5690d2c..541306d 100644 --- a/website/blog/2015-01-19-openocd-v0.8.0-20150119-released.mdx +++ b/website/blog/2015-01-19-openocd-v0.8.0-20150119-released.mdx @@ -19,4 +19,4 @@ Version **0.8.0-20150119\*** is a maintenance release. -

Binary files »

+

Binary files »

diff --git a/website/blog/2015-01-31-openocd-v0.8.0-20150131-released.mdx b/website/blog/2015-01-31-openocd-v0.8.0-20150131-released.mdx index 81e1204..7e85aeb 100644 --- a/website/blog/2015-01-31-openocd-v0.8.0-20150131-released.mdx +++ b/website/blog/2015-01-31-openocd-v0.8.0-20150131-released.mdx @@ -19,7 +19,7 @@ For a better integrations with the GNU ARM Eclipse debug plug-ins, a new distrib -

Binary files »

+

Binary files »

The first benefit of using this distribution is **user convenience**, on Windows and macOS the program is packed as a Setup package. diff --git a/website/blog/2015-03-20-openocd-v0.8.0-20150320-released.mdx b/website/blog/2015-03-20-openocd-v0.8.0-20150320-released.mdx index 0f16155..89153c3 100644 --- a/website/blog/2015-03-20-openocd-v0.8.0-20150320-released.mdx +++ b/website/blog/2015-03-20-openocd-v0.8.0-20150320-released.mdx @@ -19,4 +19,4 @@ Version **0.8.0-20150320\*** is a maintenance release. -

Binary files »

+

Binary files »

diff --git a/website/blog/2015-03-20-openocd-v0.9.0-20150320-released.mdx b/website/blog/2015-03-20-openocd-v0.9.0-20150320-released.mdx index c0fcf08..0116841 100644 --- a/website/blog/2015-03-20-openocd-v0.9.0-20150320-released.mdx +++ b/website/blog/2015-03-20-openocd-v0.9.0-20150320-released.mdx @@ -19,7 +19,7 @@ The latest development version of OpenOCD (**0.9.0-dev**) is now available as mu -

Binary files »

+

Binary files »

For those who want the latest OpenOCD features before the stable version is announced, the latest OpenOCD version built from the development repository was released in packages explicitly marked as **-dev**. diff --git a/website/blog/2015-03-24-openocd-v0.8.0-20150324-released.mdx b/website/blog/2015-03-24-openocd-v0.8.0-20150324-released.mdx index 34d9462..93c0e1e 100644 --- a/website/blog/2015-03-24-openocd-v0.8.0-20150324-released.mdx +++ b/website/blog/2015-03-24-openocd-v0.8.0-20150324-released.mdx @@ -19,4 +19,4 @@ Version **0.8.0-20150324\*** is a maintenance release. -

Binary files »

+

Binary files »

diff --git a/website/blog/2015-03-24-openocd-v0.9.0-20150324-dev-released.mdx b/website/blog/2015-03-24-openocd-v0.9.0-20150324-dev-released.mdx index a48dd15..6a4ccf4 100644 --- a/website/blog/2015-03-24-openocd-v0.9.0-20150324-dev-released.mdx +++ b/website/blog/2015-03-24-openocd-v0.9.0-20150324-dev-released.mdx @@ -19,4 +19,4 @@ Version **0.9.0-20150324\*-dev** is a maintenance release. -

Binary files »

+

Binary files »

diff --git a/website/blog/2015-05-19-openocd-v0.9.0-20150519-released.mdx b/website/blog/2015-05-19-openocd-v0.9.0-20150519-released.mdx index 340451c..d499d6b 100644 --- a/website/blog/2015-05-19-openocd-v0.9.0-20150519-released.mdx +++ b/website/blog/2015-05-19-openocd-v0.9.0-20150519-released.mdx @@ -19,7 +19,7 @@ The just released stable version of OpenOCD (**0.9.0**) is now also available as -

Binary files »

+

Binary files »

Install the proper package, and then update the path in _Eclipse_ menu → **(Window →) Preferences** → **Run/Debug** → **OpenOCD** to the new folder. If installed in the default location, the **Restore Defaults** button should automatically configure the proper path. diff --git a/website/blog/2015-10-28-openocd-v0.10.0-20151028-dev-released.mdx b/website/blog/2015-10-28-openocd-v0.10.0-20151028-dev-released.mdx index cf00a2f..d6a7d54 100644 --- a/website/blog/2015-10-28-openocd-v0.10.0-20151028-dev-released.mdx +++ b/website/blog/2015-10-28-openocd-v0.10.0-20151028-dev-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-201510281129-dev** is a maintenance release. It includes binari -

Binary files »

+

Binary files »

## Development version @@ -35,7 +35,7 @@ The debug plug-in generally discovers the latest installed version, by using the ## Download -The new OpenOCD can be downloaded from the GitHub Releases page. +The new OpenOCD can be downloaded from the GitHub Releases page. The MD5 sums of the files are: diff --git a/website/blog/2016-01-11-openocd-v0.10.0-201601101000-dev-released.mdx b/website/blog/2016-01-11-openocd-v0.10.0-201601101000-dev-released.mdx index 76294bf..03fd5a8 100644 --- a/website/blog/2016-01-11-openocd-v0.10.0-201601101000-dev-released.mdx +++ b/website/blog/2016-01-11-openocd-v0.10.0-201601101000-dev-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-201601101000-dev** is a maintenance release. It includes binari -

Binary files »

+

Binary files »

## Development version @@ -35,7 +35,7 @@ The debug plug-in generally discovers the latest installed version, by using the ## Download -The new OpenOCD can be downloaded from the GitHub Releases page. +The new OpenOCD can be downloaded from the GitHub Releases page. The MD5 sums of the files are: diff --git a/website/blog/2016-10-28-openocd-v0-10-0-20161028-dev-released.mdx b/website/blog/2016-10-28-openocd-v0-10-0-20161028-dev-released.mdx index 759f5de..f61d020 100644 --- a/website/blog/2016-10-28-openocd-v0-10-0-20161028-dev-released.mdx +++ b/website/blog/2016-10-28-openocd-v0-10-0-20161028-dev-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-201610281609-dev** is a maintenance release. It includes binari -

Binary files »

+

Binary files »

## Development version @@ -43,7 +43,7 @@ In addition to the official OpenOCD changes, the only small functional improveme ## Download -The new OpenOCD can be downloaded from the GitHub Releases page. +The new OpenOCD can be downloaded from the GitHub Releases page. The MD5 sums of the files are: diff --git a/website/blog/2017-01-24-openocd-v0-10-0-20170124-released.mdx b/website/blog/2017-01-24-openocd-v0-10-0-20170124-released.mdx index 8c5fdcc..cc9ca0c 100644 --- a/website/blog/2017-01-24-openocd-v0-10-0-20170124-released.mdx +++ b/website/blog/2017-01-24-openocd-v0-10-0-20170124-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-201701241841** is a major stable release. It includes binaries -

Binary files »

+

Binary files »

## Stable version @@ -37,7 +37,7 @@ One important note: the old `ft2232` interface was deprecated and replaced by th ## Download -The new OpenOCD can be downloaded from the GitHub Releases page. +The new OpenOCD can be downloaded from the GitHub Releases page. The MD5 sums of the files are: diff --git a/website/blog/2017-04-18-openocd-v0-10-0-20170418-released.mdx b/website/blog/2017-04-18-openocd-v0-10-0-20170418-released.mdx index 042f193..7dbc603 100644 --- a/website/blog/2017-04-18-openocd-v0-10-0-20170418-released.mdx +++ b/website/blog/2017-04-18-openocd-v0-10-0-20170418-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-201704182147** is a maintenance release. It updates `libhid.a` -

Binary files »

+

Binary files »

## Stable version @@ -41,7 +41,7 @@ The following build related issues were fixed: ## Download -The new OpenOCD can be downloaded from the GitHub Releases page. +The new OpenOCD can be downloaded from the GitHub Releases page. The SHA sums of the files are: diff --git a/website/blog/2017-08-26-openocd-v0-10-0-3-20170826-dev-released.mdx b/website/blog/2017-08-26-openocd-v0-10-0-3-20170826-dev-released.mdx index 3208fae..795de1e 100644 --- a/website/blog/2017-08-26-openocd-v0-10-0-3-20170826-dev-released.mdx +++ b/website/blog/2017-08-26-openocd-v0-10-0-3-20170826-dev-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-3-20170826-1813-dev** is a maintenance release; it updates to t -

Binary files »

+

Binary files »

[2017-09-20 update] **It was reported that the RISC-V specific changes have a negative impact on some other targets. Until the problem is identified and a fix released, for non-RISC-V targets please use an older release.** diff --git a/website/blog/2017-10-04-openocd-v0-10-0-4-20171004-dev-released.mdx b/website/blog/2017-10-04-openocd-v0-10-0-4-20171004-dev-released.mdx index e6e18d0..5f47f09 100644 --- a/website/blog/2017-10-04-openocd-v0-10-0-4-20171004-dev-released.mdx +++ b/website/blog/2017-10-04-openocd-v0-10-0-4-20171004-dev-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-4-20171004-0812-dev** is a maintenance release; the main change -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2017-11-10-openocd-v0-10-0-5-20171110-released.mdx b/website/blog/2017-11-10-openocd-v0-10-0-5-20171110-released.mdx index aa65939..75b49ee 100644 --- a/website/blog/2017-11-10-openocd-v0-10-0-5-20171110-released.mdx +++ b/website/blog/2017-11-10-openocd-v0-10-0-5-20171110-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-5-20171110** is a maintenance release; the main change was to p -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2018-01-12-openocd-v0-10-0-6-20180112-released.mdx b/website/blog/2018-01-12-openocd-v0-10-0-6-20180112-released.mdx index 16bdd23..6028351 100644 --- a/website/blog/2018-01-12-openocd-v0-10-0-6-20180112-released.mdx +++ b/website/blog/2018-01-12-openocd-v0-10-0-6-20180112-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-6-20180112** is a maintenance release; the main change was to u -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2018-01-23-openocd-v0-10-0-7-20180123-released.mdx b/website/blog/2018-01-23-openocd-v0-10-0-7-20180123-released.mdx index 852695e..dfd0862 100644 --- a/website/blog/2018-01-23-openocd-v0-10-0-7-20180123-released.mdx +++ b/website/blog/2018-01-23-openocd-v0-10-0-7-20180123-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-7-20180123** is a maintenance release; the main change was to * -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2018-05-12-openocd-v0-10-0-8-20180512-released.mdx b/website/blog/2018-05-12-openocd-v0-10-0-8-20180512-released.mdx index 5848ffb..9cbde92 100644 --- a/website/blog/2018-05-12-openocd-v0-10-0-8-20180512-released.mdx +++ b/website/blog/2018-05-12-openocd-v0-10-0-8-20180512-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-8-20180512** is a maintenance release; it updates to the latest -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2018-10-16-openocd-v0-10-0-9-20181016-released.mdx b/website/blog/2018-10-16-openocd-v0-10-0-9-20181016-released.mdx index 13aa09b..a39c963 100644 --- a/website/blog/2018-10-16-openocd-v0-10-0-9-20181016-released.mdx +++ b/website/blog/2018-10-16-openocd-v0-10-0-9-20181016-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-9-20181016** is a maintenance release; it updates to the latest -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2018-10-20-openocd-v0-10-0-10-20181020-released.mdx b/website/blog/2018-10-20-openocd-v0-10-0-10-20181020-released.mdx index 925d9da..06ad05e 100644 --- a/website/blog/2018-10-20-openocd-v0-10-0-10-20181020-released.mdx +++ b/website/blog/2018-10-20-openocd-v0-10-0-10-20181020-released.mdx @@ -19,7 +19,7 @@ Version **0.10.0-10-20181020** is a maintenance release; it fixes a small build -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2019-01-18-openocd-v0-10-0-11-20190118-released.mdx b/website/blog/2019-01-18-openocd-v0-10-0-11-20190118-released.mdx index ce08c13..13e5ecc 100644 --- a/website/blog/2019-01-18-openocd-v0-10-0-11-20190118-released.mdx +++ b/website/blog/2019-01-18-openocd-v0-10-0-11-20190118-released.mdx @@ -20,7 +20,7 @@ master and removes the RISC-V patches. -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2019-04-22-openocd-v0-10-0-12-20190422-released.mdx b/website/blog/2019-04-22-openocd-v0-10-0-12-20190422-released.mdx index 52b5a4c..3b9c844 100644 --- a/website/blog/2019-04-22-openocd-v0-10-0-12-20190422-released.mdx +++ b/website/blog/2019-04-22-openocd-v0-10-0-12-20190422-released.mdx @@ -20,7 +20,7 @@ latest upstream master. -

Binary files »

+

Binary files »

## Changes diff --git a/website/blog/2019-07-17-openocd-v0-10-0-13-released.mdx b/website/blog/2019-07-17-openocd-v0-10-0-13-released.mdx index e1d4a56..73896cb 100644 --- a/website/blog/2019-07-17-openocd-v0-10-0-13-released.mdx +++ b/website/blog/2019-07-17-openocd-v0-10-0-13-released.mdx @@ -26,7 +26,7 @@ import Image from '@theme/IdealImage'; ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Install @@ -115,7 +115,7 @@ xpack-openocd-0.10.0-13-win32-x64.zip ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2020-06-26-openocd-v0-10-0-14-released.mdx b/website/blog/2020-06-26-openocd-v0-10-0-14-released.mdx index eb3a354..b9235b7 100644 --- a/website/blog/2020-06-26-openocd-v0-10-0-14-released.mdx +++ b/website/blog/2020-06-26-openocd-v0-10-0-14-released.mdx @@ -37,7 +37,7 @@ like **Raspberry Pi**, was added. ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Install @@ -132,8 +132,8 @@ On Arm platforms, where Eclipse is not yet available, the binaries were tested on Raspberry Pi OS 10 (buster) 32/64-bit only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} In all cases, install the archive in Downloads and configure the path in Eclipse or run manually from there. @@ -168,7 +168,7 @@ xpack-openocd-0.10.0-14-win32-x64.zip ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2020-10-13-openocd-v0-10-0-15-released.mdx b/website/blog/2020-10-13-openocd-v0-10-0-15-released.mdx index 36c375d..4c130dd 100644 --- a/website/blog/2020-10-13-openocd-v0-10-0-15-released.mdx +++ b/website/blog/2020-10-13-openocd-v0-10-0-15-released.mdx @@ -42,7 +42,7 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Install @@ -134,8 +134,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -173,7 +173,7 @@ xpack-openocd-0.10.0-15-win32-x64.zip ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2021-03-15-openocd-v0-11-0-1-released.mdx b/website/blog/2021-03-15-openocd-v0-11-0-1-released.mdx index 8de3145..3f83f44 100644 --- a/website/blog/2021-03-15-openocd-v0-11-0-1-released.mdx +++ b/website/blog/2021-03-15-openocd-v0-11-0-1-released.mdx @@ -42,7 +42,7 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Install @@ -134,8 +134,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -173,7 +173,7 @@ xpack-openocd-0.11.0-1-win32-x64.zip ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2021-10-16-openocd-v0-11-0-2-released.mdx b/website/blog/2021-10-16-openocd-v0-11-0-2-released.mdx index f5b4dab..14923f8 100644 --- a/website/blog/2021-10-16-openocd-v0-11-0-2-released.mdx +++ b/website/blog/2021-10-16-openocd-v0-11-0-2-released.mdx @@ -42,7 +42,7 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites @@ -55,7 +55,7 @@ The binary files are available from GitHub - Intel Windows 32/64-bit: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later +- x64 macOS: 10.13 or later ## Install @@ -134,7 +134,7 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`% ~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg +`% ~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg xPack OpenOCD x86_64 Open On-Chip Debugger 0.11.0+dev (2021-10-17-00:10) Licensed under GNU GPL v2 For bug reports, read @@ -153,8 +153,8 @@ Info : starting gdb server for stm32f4x.cpu on 3333 Info : Listening on port 3333 for gdb connections target halted due to breakpoint, current mode: Thread xPSR: 0x21000000 pc: 0x0800113c msp: 0x2001ff78 -^Cshutdown command invoked -`} +^Cshutdown command invoked` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -207,7 +207,7 @@ with Ubuntu 18 and RedHat 8. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2021-12-07-openocd-v0-11-0-3-released.mdx b/website/blog/2021-12-07-openocd-v0-11-0-3-released.mdx index c8e7904..b2cffd4 100644 --- a/website/blog/2021-12-07-openocd-v0-11-0-3-released.mdx +++ b/website/blog/2021-12-07-openocd-v0-11-0-3-released.mdx @@ -43,7 +43,7 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites @@ -56,8 +56,8 @@ The binary files are available from GitHub - Intel Windows 32/64-bit: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later -- Apple Silicon macOS 64-bit: 11.6 or later +- x64 macOS: 10.13 or later +- arm64 macOS: 11.6 or later ## Install @@ -138,8 +138,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -195,7 +195,7 @@ with Ubuntu 18 and RedHat 8. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2022-03-25-openocd-v0-11-0-4-released.mdx b/website/blog/2022-03-25-openocd-v0-11-0-4-released.mdx index a353e12..be1036c 100644 --- a/website/blog/2022-03-25-openocd-v0-11-0-4-released.mdx +++ b/website/blog/2022-03-25-openocd-v0-11-0-4-released.mdx @@ -32,9 +32,8 @@ The [xPack OpenOCD](https://xpack-dev-tools.github.io/openocd-xpack) is a standalone cross-platform binary distribution of [OpenOCD](https://openocd.org). -There are separate binaries for **Windows** (Intel 64-bit), -**macOS** (Intel 64-bit, Apple Silicon 64-bit) -and **GNU/Linux** (Intel 64-bit, Arm 32/64-bit). +There are separate binaries for **Windows** (x64), +**macOS** (x64 and arm64) and **GNU/Linux** (x64, arm64 and arm). :::note Raspberry Pi @@ -46,21 +45,21 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites -- GNU/Linux Intel 64-bit: any system with **GLIBC 2.27** or higher +- x64 GNU/Linux: any system with **GLIBC 2.27** or higher (like Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- GNU/Linux Arm 32/64-bit: any system with **GLIBC 2.27** or higher +- arm64/arm GNU/Linux: any system with **GLIBC 2.27** or higher (like Raspberry Pi OS, Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- Intel Windows 64-bit: Windows 7 with the Universal C Runtime +- x64 Windows: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later -- Apple Silicon macOS 64-bit: 11.6 or later +- x64 macOS: 10.13 or later +- arm64 macOS: 11.6 or later ## Install @@ -74,7 +73,7 @@ The **xPack OpenOCD** generally follows the official The current version is based on: -- OpenOCD version { frontMatter.upstream_version }, the development commit { frontMatter.upstream_commit } from { frontMatter.upstream_release_date }. +- OpenOCD version {frontMatter.upstream_version}, the development commit {frontMatter.upstream_commit} from {frontMatter.upstream_release_date}. ## Changes @@ -139,8 +138,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -190,7 +189,7 @@ with Ubuntu 18, Debian 10 and RedHat 8. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2022-09-01-openocd-v0-11-0-5-released.mdx b/website/blog/2022-09-01-openocd-v0-11-0-5-released.mdx index 2f8434c..33ddbfa 100644 --- a/website/blog/2022-09-01-openocd-v0-11-0-5-released.mdx +++ b/website/blog/2022-09-01-openocd-v0-11-0-5-released.mdx @@ -32,9 +32,8 @@ The [xPack OpenOCD](https://xpack-dev-tools.github.io/openocd-xpack) is a standalone cross-platform binary distribution of [OpenOCD](https://openocd.org). -There are separate binaries for **Windows** (Intel 64-bit), -**macOS** (Intel 64-bit, Apple Silicon 64-bit) -and **GNU/Linux** (Intel 64-bit, Arm 32/64-bit). +There are separate binaries for **Windows** (x64), +**macOS** (x64 and arm64) and **GNU/Linux** (x64, arm64 and arm). :::note Raspberry Pi @@ -46,21 +45,21 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites -- GNU/Linux Intel 64-bit: any system with **GLIBC 2.27** or higher +- x64 GNU/Linux: any system with **GLIBC 2.27** or higher (like Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- GNU/Linux Arm 32/64-bit: any system with **GLIBC 2.27** or higher +- arm64/arm GNU/Linux: any system with **GLIBC 2.27** or higher (like Raspberry Pi OS, Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- Intel Windows 64-bit: Windows 7 with the Universal C Runtime +- x64 Windows: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later -- Apple Silicon macOS 64-bit: 11.6 or later +- x64 macOS: 10.13 or later +- arm64 macOS: 11.6 or later ## Install @@ -74,7 +73,7 @@ The **xPack OpenOCD** generally follows the official The current version is based on: -- OpenOCD version { frontMatter.upstream_version }, the development commit { frontMatter.upstream_commit } from { frontMatter.upstream_release_date }. +- OpenOCD version {frontMatter.upstream_version}, the development commit {frontMatter.upstream_commit} from {frontMatter.upstream_release_date}. ## Changes @@ -139,8 +138,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -190,7 +189,7 @@ with Ubuntu 18, Debian 10 and RedHat 8. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2023-01-30-openocd-v0-12-0-1-released.mdx b/website/blog/2023-01-30-openocd-v0-12-0-1-released.mdx index c707d37..76d2a95 100644 --- a/website/blog/2023-01-30-openocd-v0-12-0-1-released.mdx +++ b/website/blog/2023-01-30-openocd-v0-12-0-1-released.mdx @@ -32,9 +32,8 @@ The [xPack OpenOCD](https://xpack-dev-tools.github.io/openocd-xpack) is a standalone cross-platform binary distribution of [OpenOCD](https://openocd.org). -There are separate binaries for **Windows** (Intel 64-bit), -**macOS** (Intel 64-bit, Apple Silicon 64-bit) -and **GNU/Linux** (Intel 64-bit, Arm 32/64-bit). +There are separate binaries for **Windows** (x64), +**macOS** (x64 and arm64) and **GNU/Linux** (x64, arm64 and arm). :::note Raspberry Pi @@ -46,21 +45,21 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites -- GNU/Linux Intel 64-bit: any system with **GLIBC 2.27** or higher +- x64 GNU/Linux: any system with **GLIBC 2.27** or higher (like Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- GNU/Linux Arm 32/64-bit: any system with **GLIBC 2.27** or higher +- arm64/arm GNU/Linux: any system with **GLIBC 2.27** or higher (like Raspberry Pi OS, Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- Intel Windows 64-bit: Windows 7 with the Universal C Runtime +- x64 Windows: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later -- Apple Silicon macOS 64-bit: 11.6 or later +- x64 macOS: 10.13 or later +- arm64 macOS: 11.6 or later ## Install @@ -74,7 +73,7 @@ The **xPack OpenOCD** generally follows the official The current version is based on: -- OpenOCD version { frontMatter.upstream_version }, the development commit { frontMatter.upstream_commit } from { frontMatter.upstream_release_date }. +- OpenOCD version {frontMatter.upstream_version}, the development commit {frontMatter.upstream_commit} from {frontMatter.upstream_release_date}. ## Changes @@ -138,8 +137,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -189,7 +188,7 @@ with Ubuntu 18, Debian 10 and RedHat 8. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2023-09-04-openocd-v0-12-0-2-released.mdx b/website/blog/2023-09-04-openocd-v0-12-0-2-released.mdx index 3142434..691f39d 100644 --- a/website/blog/2023-09-04-openocd-v0-12-0-2-released.mdx +++ b/website/blog/2023-09-04-openocd-v0-12-0-2-released.mdx @@ -33,9 +33,8 @@ The [xPack OpenOCD](https://xpack.github.io/openocd/) is a standalone cross-platform binary distribution of [OpenOCD](https://openocd.org). -There are separate binaries for **Windows** (Intel 64-bit), -**macOS** (Intel 64-bit, Apple Silicon 64-bit) -and **GNU/Linux** (Intel 64-bit, Arm 32/64-bit). +There are separate binaries for **Windows** (x64), +**macOS** (x64 and arm64) and **GNU/Linux** (x64, arm64 and arm). :::note Raspberry Pi @@ -47,21 +46,21 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites -- GNU/Linux Intel 64-bit: any system with **GLIBC 2.27** or higher +- x64 GNU/Linux: any system with **GLIBC 2.27** or higher (like Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- GNU/Linux Arm 32/64-bit: any system with **GLIBC 2.27** or higher +- arm64/arm GNU/Linux: any system with **GLIBC 2.27** or higher (like Raspberry Pi OS, Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- Intel Windows 64-bit: Windows 7 with the Universal C Runtime +- x64 Windows: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later -- Apple Silicon macOS 64-bit: 11.6 or later +- x64 macOS: 10.13 or later +- arm64 macOS: 11.6 or later ## Install @@ -75,7 +74,7 @@ The **xPack OpenOCD** generally follows the official The current version is based on: -- OpenOCD version { frontMatter.upstream_version }, the development commit { frontMatter.upstream_commit } from { frontMatter.upstream_release_date }. +- OpenOCD version {frontMatter.upstream_version}, the development commit {frontMatter.upstream_commit} from {frontMatter.upstream_release_date}. ## Changes @@ -135,8 +134,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -200,7 +199,7 @@ ensure a smooth transition to the next xPack releases. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/2024-04-02-openocd-v0-12-0-3-released.mdx b/website/blog/2024-04-02-openocd-v0-12-0-3-released.mdx index 4ced62d..60e37d7 100644 --- a/website/blog/2024-04-02-openocd-v0-12-0-3-released.mdx +++ b/website/blog/2024-04-02-openocd-v0-12-0-3-released.mdx @@ -33,9 +33,8 @@ The [xPack OpenOCD](https://xpack.github.io/openocd/) is a standalone cross-platform binary distribution of [OpenOCD](https://openocd.org). -There are separate binaries for **Windows** (Intel 64-bit), -**macOS** (Intel 64-bit, Apple Silicon 64-bit) -and **GNU/Linux** (Intel 64-bit, Arm 32/64-bit). +There are separate binaries for **Windows** (x64), +**macOS** (x64 and arm64) and **GNU/Linux** (x64, arm64 and arm). :::note Raspberry Pi @@ -47,21 +46,21 @@ armv6 is not supported). ## Download -The binary files are available from GitHub Releases. +The binary files are available from GitHub Releases. ## Prerequisites -- GNU/Linux Intel 64-bit: any system with **GLIBC 2.27** or higher +- x64 GNU/Linux: any system with **GLIBC 2.27** or higher (like Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- GNU/Linux Arm 32/64-bit: any system with **GLIBC 2.27** or higher +- arm64/arm GNU/Linux: any system with **GLIBC 2.27** or higher (like Raspberry Pi OS, Ubuntu 18 or later, Debian 10 or later, RedHat 8 or later, Fedora 29 or later, etc) -- Intel Windows 64-bit: Windows 7 with the Universal C Runtime +- x64 Windows: Windows 7 with the Universal C Runtime ([UCRT](https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c)), Windows 8, Windows 10 -- Intel macOS 64-bit: 10.13 or later -- Apple Silicon macOS 64-bit: 11.6 or later +- x64 macOS: 10.13 or later +- arm64 macOS: 11.6 or later ## Install @@ -75,7 +74,7 @@ The **xPack OpenOCD** generally follows the official The current version is based on: -- OpenOCD version { frontMatter.upstream_version }, the development commit { frontMatter.upstream_commit } from { frontMatter.upstream_release_date }. +- OpenOCD version {frontMatter.upstream_version}, the development commit {frontMatter.upstream_commit} from {frontMatter.upstream_release_date}. ## Changes @@ -135,8 +134,8 @@ The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board. { -`~/Library/xPacks/@xpack-dev-tools/openocd/${ frontMatter.version }.${ frontMatter.npm_subversion }/.content/bin/openocd -f board/stm32f4discovery.cfg -`} +`~/Library/xPacks/@xpack-dev-tools/openocd/${frontMatter.version}.${frontMatter.npm_subversion}/.content/bin/openocd -f board/stm32f4discovery.cfg` +} A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were @@ -207,7 +206,7 @@ ensure a smooth transition to the next xPack releases. ## Download analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) diff --git a/website/blog/_common/_download-analytics.mdx b/website/blog/_common/_download-analytics.mdx index 96e01c3..e0dedb9 100644 --- a/website/blog/_common/_download-analytics.mdx +++ b/website/blog/_common/_download-analytics.mdx @@ -8,10 +8,10 @@ import Image from '@theme/IdealImage'; ## Analytics - GitHub [xpack-dev-tools/openocd-xpack](https://github.com/xpack-dev-tools/openocd-xpack/) - - this release Github Release + - this release Github Release - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) + - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped by release) - npmjs.com [@xpack-dev-tools/openocd](https://www.npmjs.com/package/@xpack-dev-tools/openocd) - latest releases [![npm](https://img.shields.io/npm/dw/@xpack-dev-tools/openocd.svg)](https://www.npmjs.com/package/@xpack-dev-tools/openocd/) - all @xpack-dev-tools releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/openocd.svg)](https://www.npmjs.com/package/@xpack-dev-tools/openocd/) diff --git a/website/docs/developer/_common/_platform-docker-section.mdx b/website/docs/developer/_common/_platform-docker-section.mdx index fd1b78f..ac998b6 100644 --- a/website/docs/developer/_common/_platform-docker-section.mdx +++ b/website/docs/developer/_common/_platform-docker-section.mdx @@ -4,20 +4,20 @@ import CodeBlock from '@theme/CodeBlock'; import customField from '@site/src/libs/customField'; -import { developmentDurations } from '../../maintainer/_development-durations.mdx' +import {developmentDurations} from '../../maintainer/_development-durations.mdx' {/* ------------------------------------------------------------------------ */} {/* Arguments: props.platform */} -{ props.platform == "win32-x64" ? (

The Windows builds run on GNU/Linux, using mingw-w64.

) : ''} +{props.platform == "win32-x64" ? (

The Windows builds run on GNU/Linux, using mingw-w64.

) : ''} To prepare the docker build: { `xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm run docker-prepare --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`}
... or, with the writable helper ... @@ -25,33 +25,33 @@ xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/op { `xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ xpm run link-deps -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-link-deps --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm run docker-prepare --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run docker-link-deps --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`}
To run the docker build: { -`xpm run docker-build --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +`xpm run docker-build --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} or, for more verbosity, run the similar development build: { -`xpm run docker-build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +`xpm run docker-build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} -{ developmentDurations[ props.platform ] }, the output of the build script is a compressed +{developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{ props.platform }/deploy folder: +the buils-assets/build/{props.platform}/deploy folder: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.tar.gz -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.tar.gz.sha +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.tar.gz.sha To rerun the build, invoke the **deep-clean** action and repeat from install: { -`xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +`xpm run deep-clean --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} diff --git a/website/docs/developer/_common/_platform-native-section.mdx b/website/docs/developer/_common/_platform-native-section.mdx index 5c22e01..810b5c6 100644 --- a/website/docs/developer/_common/_platform-native-section.mdx +++ b/website/docs/developer/_common/_platform-native-section.mdx @@ -4,7 +4,7 @@ import CodeBlock from '@theme/CodeBlock'; import customField from '@site/src/libs/customField'; -import { developmentDurations } from '../../maintainer/_development-durations.mdx' +import {developmentDurations} from '../../maintainer/_development-durations.mdx' {/* ------------------------------------------------------------------------ */} @@ -14,8 +14,8 @@ To prepare the native build: { `xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm install --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`}
... or, with the writable helper ... @@ -23,32 +23,32 @@ xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack { `xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ xpm run link-deps -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm install --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`}
To run the native build: { -`xpm run build --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +`xpm run build --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} or, for more verbosity, run the similar development build: { -`xpm run build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +`xpm run build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} -{ developmentDurations[ props.platform ] }, the output of the build script is a compressed +{developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{ props.platform }/deploy folder: +the buils-assets/build/{props.platform}/deploy folder: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.tar.gz -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.tar.gz.sha +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.tar.gz.sha To rerun the build, invoke the **deep-clean** action and repeat from install: { -`xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +`xpm run deep-clean --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx index 3271360..229d549 100644 --- a/website/docs/developer/index.mdx +++ b/website/docs/developer/index.mdx @@ -92,8 +92,8 @@ The build configurations are defined in the `package.json` file, in the "...":"...", "xpack": { "buildConfigurations": { - "...": { - }, + "...": { + }, "win32-x64": { "inherit": [ "common-dependencies", @@ -109,10 +109,10 @@ The build configurations are defined in the `package.json` file, in the "dockerImage": "ilegeul/ubuntu:amd64-18.04-xbb-v5.2.2" }, "actions": { - "build": "{{ properties.commandBashBuild }} --windows", - "build-development": "{{ properties.commandBashBuild }} --windows --development", - "build-development-debug": "{{ properties.commandBashBuild }} --windows --development --debug", - "build-development-tests-only": "{{ properties.commandBashBuild }} --windows --development --tests-only" + "build": "{{properties.commandBashBuild}} --windows", + "build-development": "{{properties.commandBashBuild}} --windows --development", + "build-development-debug": "{{properties.commandBashBuild}} --windows --development --debug", + "build-development-tests-only": "{{properties.commandBashBuild}} --windows --development --tests-only" } } } diff --git a/website/docs/getting-started/_common/_gcc-release-schedule.mdx b/website/docs/getting-started/_common/_gcc-release-schedule.mdx index 28a441e..93d9a94 100644 --- a/website/docs/getting-started/_common/_gcc-release-schedule.mdx +++ b/website/docs/getting-started/_common/_gcc-release-schedule.mdx @@ -1,7 +1,7 @@ {/* DO NOT EDIT! */} {/* Automatically generated from xbb-helper/templates/docusaurus/common. */} -import versionMajor from '@site/src/libs/versionMajor'; +import versionMajor from '@site/src/libs/versions'; {/* ------------------------------------------------------------------------ */} @@ -10,11 +10,11 @@ import versionMajor from '@site/src/libs/versionMajor'; This distribution generally follows the official [GCC release](https://gcc.gnu.org/releases.html) timeline. -For each major version there are 2 releases, like **{ versionMajor() }.1** +For each major version there are 2 releases, like **{versionMajor()}.1** in the first part of the year (tentatively April-May) and -**{ versionMajor() }.2** in the second part +**{versionMajor()}.2** in the second part (tentatively in August-September). Previous versions are maintained for 3 more years, and, around midyear, GNU releases updates for the previous 3 versions, -(like **{ versionMajor() - 1 }.3**, **{ versionMajor() - 2 }.4**, **{ versionMajor() - 3 }.5**). +(like **{versionMajor() - 1}.3**, **{versionMajor() - 2}.4**, **{versionMajor() - 3}.5**). diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index 6bfaf24..bf94d44 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -31,14 +31,14 @@ intended for reproducible builds. -**xPack OpenOCD** is an open source project hosted on GitHub as +The open source **xPack OpenOCD** project is hosted on GitHub as [`xpack-dev-tools/openocd-xpack`](https://github.com/xpack-dev-tools/openocd-xpack); it provides the platform specific binaries as [release assets](https://github.com/xpack-dev-tools/openocd-xpack/releases). In addition to the binary archives and the package metadata, this project also includes the -[build scripts](https://github.com/xpack-dev-tools/openocd-xpack/tree/xpack/scripts). +[build scripts](https://github.com/xpack-dev-tools/openocd-xpack/tree/xpack/build-assets/scripts). @@ -93,13 +93,15 @@ The details of installing the **xPack OpenOCD** on various platforms are presented in the [Install Guide](/docs/install/). +## Documentation + -## Support +## Support & feedback -The quick advice for getting support is to use the +The quick advice for getting support and providing feedback is to use the [GitHub Discussions](https://github.com/xpack-dev-tools/openocd-xpack/discussions/). For additional information, please refer to the diff --git a/website/docs/install/_common/_automatic-install-quick-test.mdx b/website/docs/install/_common/_automatic-install-quick-test.mdx index 7c59be5..b30d9ac 100644 --- a/website/docs/install/_common/_automatic-install-quick-test.mdx +++ b/website/docs/install/_common/_automatic-install-quick-test.mdx @@ -11,31 +11,35 @@ import customField from '@site/src/libs/customField'; ### Quick test -To check if the { props.appName } installed by **xpm** starts properly, use something like: +To check if the {props.appName} installed by **xpm** starts properly, use something like: + { -`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\${ props.appLcName }\\${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }\\.content\\bin\\${ props.programName }.exe --version -${ props.branding }${ customField('upstreamVersion') }` -} +`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\${props.appLcName}\\${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}\\.content\\bin\\${props.programName}.exe --version +${props.branding}${customField('upstreamVersion')} +`} + { -`% ~/Library/xPacks/@xpack-dev-tools/${ props.appLcName }/${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }/.content/bin/${ props.programName } --version -${ props.branding }${ customField('upstreamVersion') }` -} +`% ~/Library/xPacks/@xpack-dev-tools/${props.appLcName}/${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version +${props.branding}${customField('upstreamVersion')} +`} + { -`$ ~/.local/xPacks/@xpack-dev-tools/${ props.appLcName }/${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }/.content/bin/${ props.programName } --version -${ props.branding }${ customField('upstreamVersion') }` -} +`$ ~/.local/xPacks/@xpack-dev-tools/${props.appLcName}/${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version +${props.branding}${customField('upstreamVersion')} +`} + diff --git a/website/docs/install/_common/_manual-install-quick-test.mdx b/website/docs/install/_common/_manual-install-quick-test.mdx index 47cd2f8..0e279ba 100644 --- a/website/docs/install/_common/_manual-install-quick-test.mdx +++ b/website/docs/install/_common/_manual-install-quick-test.mdx @@ -11,31 +11,35 @@ import customField from '@site/src/libs/customField'; ### Quick test {#manual-install-quick-test} -To check if the { props.appName } installed manually starts properly, use something like: +To check if the {props.appName} installed manually starts properly, use something like: + { -`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\${ props.appLcName }\\xpack-${ props.appLcName }-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }\\bin\\${ props.programName }.exe --version -${ props.branding }${ customField('upstreamVersion') }` -} +`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\${props.appLcName}\\xpack-${props.appLcName}-${customField('upstreamVersion')}-${customField('xpackSubversion')}\\bin\\${props.programName}.exe --version +${props.branding}${customField('upstreamVersion')} +`} + { -`% ~/Library/xPacks/${ props.appLcName }/xpack-${ props.appLcName }-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }/bin/${ props.programName } --version -${ props.branding }${ customField('upstreamVersion') }` -} +`% ~/Library/xPacks/${props.appLcName}/xpack-${props.appLcName}-${customField('upstreamVersion')}-${customField('xpackSubversion')}/bin/${props.programName} --version +${props.branding}${customField('upstreamVersion')} +`} + { -`$ ~/.local/xPacks/${ props.appLcName }/xpack-${ props.appLcName }-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }/bin/${ props.programName } --version -${ props.branding }${ customField('upstreamVersion') }` -} +`$ ~/.local/xPacks/${props.appLcName}/xpack-${props.appLcName}-${customField('upstreamVersion')}-${customField('xpackSubversion')}/bin/${props.programName} --version +${props.branding}${customField('upstreamVersion')} +`} + diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index 5d1a3ec..45aa34e 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -34,7 +34,7 @@ portable archives. The easiest (and recommended) way to install OpenOCD is by using the **binary xPack**, available -as @xpack-dev-tools/openocd from +as @xpack-dev-tools/openocd from the [`npmjs.com`](https://www.npmjs.com) registry.
@@ -166,7 +166,7 @@ by passing `--copy` to `xpm install`. ::: -If needed, it is also possible to install packages only globally, without +if necessary, it is also possible to install packages only globally, without creating local links/forwarders (see below).
@@ -214,10 +214,11 @@ The next step is to install the **openocd** package into the project: { -`xpm install @xpack-dev-tools/openocd@latest --verbose` -} +`xpm install @xpack-dev-tools/openocd@latest --verbose +`} + The main result is a set @@ -225,8 +226,8 @@ of forwarders in the `.bin` folder: { -`dir xpacks\\.bin` -} +`dir xpacks\\.bin +`}
PATH setup @@ -248,6 +249,7 @@ adjust the syntax for the corresponding Windows specific shell.
+ The main result is a set @@ -255,8 +257,8 @@ of links in the `.bin` folder: { -`ls -l xpacks/.bin` -} +`ls -l xpacks/.bin +`}
PATH setup @@ -270,6 +272,7 @@ export PATH=<...project-path...>/xpacks/.bin:$PATH
+ The main result is a set @@ -277,8 +280,8 @@ of links in the `.bin` folder: { -`ls -l xpacks/.bin` -} +`ls -l xpacks/.bin +`}
PATH setup @@ -292,6 +295,7 @@ export PATH=<...project-path...>/xpacks/.bin:$PATH
+
@@ -344,7 +348,7 @@ The result looks like this: "dependencies": {}, "devDependencies": { "@xpack-dev-tools/openocd": { - "specifier": "${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }", + "specifier": "${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}", "local": "link", "platforms": "all" } @@ -352,8 +356,8 @@ The result looks like this: "properties": {}, "actions": {}, "buildConfigurations": {} - }` -} + } +`} If the `package.json` is saved in the revision system, the above definition acts as a hard reference to the specific version of @@ -377,8 +381,8 @@ is the developer's responsibility to configure the path to the tools. No other files are installed in any system folders or other locations. { -`xpm install @xpack-dev-tools/openocd@latest --global --verbose` -} +`xpm install @xpack-dev-tools/openocd@latest --global --verbose +`} :::note @@ -397,11 +401,12 @@ the user global xPacks store, the project build configurations need a PATH adjustment: + { -`export PATH=$HOME/AppData/Roaming/xPacks/\@pack-dev-tools/openocd /${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }/.content/bin:$PATH` -} +`export PATH=$HOME/AppData/Roaming/xPacks/\@pack-dev-tools/openocd /${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}/.content/bin:$PATH +`} :::tip @@ -411,20 +416,23 @@ corresponding shell. ::: + { -`export PATH=$HOME/Library/xPacks/\@pack-dev-tools/openocd /${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }/.content/bin:$PATH` -} +`export PATH=$HOME/Library/xPacks/\@pack-dev-tools/openocd /${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}/.content/bin:$PATH +`} + { -`export PATH=$HOME/.local/xPacks/@xpack-dev-tools/openocd /${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }/.content/bin:$PATH` -} +`export PATH=$HOME/.local/xPacks/@xpack-dev-tools/openocd /${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')}/.content/bin:$PATH +`} +
@@ -434,12 +442,12 @@ corresponding shell. The binaries do not use any form of installer; instead they are distributed as -portable { props.isWindows ? .zip : .tar.gz } archives; +portable {props.isWindows ? .zip : .tar.gz} archives; therefore they do not require to run any uninstaller; simply removing the links and possibly the user global xPack store folder and the user xPack cache folder is enough. -To remove the created by +To remove the created by **xpm** in the current project, go to the project folder: @@ -450,14 +458,14 @@ cd my-project and ask **xpm** to uninstall the package: { -`xpm uninstall @xpack-dev-tools/openocd --verbose` -} +`xpm uninstall @xpack-dev-tools/openocd --verbose +`} To completely remove the package from the user global xPack store: { -`xpm uninstall --global @xpack-dev-tools/openocd --verbose` -} +`xpm uninstall --global @xpack-dev-tools/openocd --verbose +`}
Clean-ups @@ -465,24 +473,28 @@ To completely remove the package from the user global xPack store: For a thorough clean-up, please note that **xpm** uses only two folders: + - `%APPDATA%\Roaming\xPacks` - `%APPDATA%\Local\Caches\xPacks` + - `${HOME}/Library/xPacks` - `${HOME}/Library/Caches/xPacks` + - `${HOME}/.local/xPacks` - `${HOME}/.cache/xPacks` + They can be removed at any time and space reclaimed; @@ -501,18 +513,19 @@ For all platforms, the **xPack OpenOCD** binaries are released as portable archives that can be installed in any location. The archives can be downloaded from -the GitHub Releases pages. +the GitHub Releases pages. ### Download & unpack {#manual-install-download-and-unpack} + The Windows versions of **xPack OpenOCD** are packed as `.zip` files. Download the latest version named like: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-win32-x64.zip +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-win32-x64.zip :::note @@ -527,7 +540,7 @@ unpack the archive and move it to a location of your choice. The recommended location is the %USERPROFILE%\\AppData\\Roaming\\xPacks\\openocd folder, for -example C:\\Users\\ilg\\AppData\\Roaming\\xPacks\\openocd\\xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }. +example C:\\Users\\ilg\\AppData\\Roaming\\xPacks\\openocd\\xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}. :::note @@ -537,14 +550,15 @@ installing user specific packages. ::: + The macOS versions of **xPack OpenOCD** are packed as `.tar.gz` archives. Download the latest version named like: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-darwin-x64.tar.gz -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-darwin-arm64.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-darwin-x64.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-darwin-arm64.tar.gz :::note @@ -558,26 +572,27 @@ unpack the archive and move it to a location of your choice. The recommended location is the ~/Library/xPacks/openocd folder, for -example /Users/ilg/Library/xPacks/openocd/xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }: +example /Users/ilg/Library/xPacks/openocd/xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}: { `mkdir -p ~/Library/xPacks/openocd cd ~/Library/xPacks/openocd -tar xvf ~/Downloads/xpack-openocd-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }-darwin-x64.tar.gz -chmod -R -w xpack-openocd-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }` -} +tar xvf ~/Downloads/xpack-openocd-${customField('upstreamVersion')}-${customField('xpackSubversion')}-darwin-x64.tar.gz +chmod -R -w xpack-openocd-${customField('upstreamVersion')}-${customField('xpackSubversion')} +`} + The GNU/Linux versions of **xPack OpenOCD** are packed as `.tar.gz` archives. Download the latest version named like: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-darwin-x64.tar.gz -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-darwin-arm64.tar.gz -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-darwin-arm.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-darwin-x64.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-darwin-arm64.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-darwin-arm.tar.gz :::note @@ -591,17 +606,18 @@ unpack the archive and move it to a location of your choice. The recommended location is the ~/.local/xPacks/openocd folder, for -example /home/ilg/.local/xPacks/openocd/xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }: +example /home/ilg/.local/xPacks/openocd/xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}: { `mkdir -p ~/.local/xPacks/openocd cd ~/.local/xPacks/openocd -tar xvf ~/Downloads/xpack-openocd-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }-linux-x64.tar.gz -chmod -R -w xpack-openocd-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }` -} +tar xvf ~/Downloads/xpack-openocd-${customField('upstreamVersion')}-${customField('xpackSubversion')}-linux-x64.tar.gz +chmod -R -w xpack-openocd-${customField('upstreamVersion')}-${customField('xpackSubversion')} +`} + :::info diff --git a/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx b/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx new file mode 100644 index 0000000..d71fa2e --- /dev/null +++ b/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx @@ -0,0 +1,36 @@ +{/* DO NOT EDIT! */} +{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} + +import customField from '@site/src/libs/customField'; + +import versionMajor from '@site/src/libs/versionMajor'; +import versionMinor from '@site/src/libs/versionMinor'; + +{/* ------------------------------------------------------------------------ */} + +### Check the latest upstream release + +The current release must be announced in +[Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads). +Compare the latest Arm release with the current xPack +[release](https://github.com/xpack-dev-tools/openocd-xpack/releases). +If necessary, update the triplet, otherwise increase the fourth & fifth numbers, +as below. + +### Update to the latest Arm release + +- download the new _Source code_ archive (like +arm-gnu-toolchain-src-snapshot-{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}.tar.xz) from +[Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads/) +- the GCC version is in `gcc/gcc/BASE-VER` +- the GDB version is in `binutils-gdb--gdb/gdb/version.in` +- the newlib version is in `newlib-cygwin/newlib/configure`, search for `VERSION=` +- download the latest **macOS (x86_64) hosted cross toolchains** archive (like +arm-gnu-toolchain-{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-darwin-x86_64-.tar.xz) +- unpack the archive +- create a folder build-assets/extras/{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')} +- copy the file with the configurations +({versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-darwin-x86_64--manifest.txt) to the new folder in extras +- download the ABE manifest with the individual source URLs +(arm-gnu-toolchain--abe-manifest.txt) +- copy to the new folder in extras diff --git a/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx b/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx new file mode 100644 index 0000000..e8d13ff --- /dev/null +++ b/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx @@ -0,0 +1,54 @@ +{/* DO NOT EDIT! */} +{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} + +import customField from '@site/src/libs/customField'; + +import versionMajor from '@site/src/libs/versionMajor'; +import versionMinor from '@site/src/libs/versionMinor'; + +{/* ------------------------------------------------------------------------ */} + +### Update the version specific code + +- open the `build-assets/scripts/versioning.sh` file +- add a new `if` with the new version before the existing code + +### Update local binutils-gdb fork + +With a Git client: + +- checkout the branch mentioned in the release notes + (like binutils-{customField('binutilsVersionMajor')}_{customField('binutilsVersionMinor')}-branch) +- push it to origin with the same name +- identify the commit ID (search back in time) +- add a tag like binutils-{customField('binutilsVersionMajor')}.{customField('binutilsVersionMinor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')} +- push the tag to origin +- check the tag at https://github.com/xpack-dev-tools/binutils-gdb/tags/ + +Similarly for GDB: + +- checkout the branch mentioned in the release notes + (like gdb-{customField('gdbVersionMajor')}-branch) +- identify the commit ID (search back in time) +- add a tag like gdb-{customField('gdbVersionMajor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')} +- push the tag to origin +- check the tag at https://github.com/xpack-dev-tools/binutils-gdb/tags/ + +### Update the local gcc fork (if the commit ID present in manifest.txt) + +With a Git client: + +- checkout the branch mentioned in the release notes + (like ARM/arm-{versionMajor()}) +- identify the commit ID (filter by branch and search downwards) +- create a branch like arm-{customField('gdbVersionMajor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')} + +### Update the gdb-*-cross.git.patch in helper + +Copy/paste a previous one; adjust if necessary. + +### Check configure options + +Verify if the configure options used in +the arm-gnu-toolchain--abe-manifest.txt file +are used in the build scripts. diff --git a/website/docs/maintainer/_common/_platform-docker-build.mdx b/website/docs/maintainer/_common/_platform-docker-build.mdx index 91dc674..f1ea7f1 100644 --- a/website/docs/maintainer/_common/_platform-docker-build.mdx +++ b/website/docs/maintainer/_common/_platform-docker-build.mdx @@ -5,32 +5,44 @@ import CodeBlock from '@theme/CodeBlock'; import customField from '@site/src/libs/customField'; -import { developmentDurations } from '../_development-durations.mdx' +import {developmentDurations} from '../_development-durations.mdx' {/* ------------------------------------------------------------------------ */} +To check the available space: + +```sh +xpm run check-space -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +``` + +To free the space used by all previous builds of all `xpack-dev-tools` packages: + +```sh +xpm run clear-all-project-builds -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +``` + To update the build scripts and build the development binaries: { -`rm -f ~/Work/xpack-dev-tools/openocd-xpack.git/package-lock.json && \\ +`rm -f ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets/package-lock.json && \\ git -C ~/Work/xpack-dev-tools/openocd-xpack.git pull && \\ xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \\ xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \\ xpm run link-deps -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ \\ -xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-link-deps --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm run deep-clean --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run docker-prepare --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run docker-link-deps --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run docker-build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} -{ developmentDurations[ props.platform ] }, the output of the build script is a compressed +{developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{ props.platform }/deploy folder: +the buils-assets/build/{props.platform}/deploy folder: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.{ props.platform === 'win32-x64' ? 'zip' : 'tar.gz' } -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.{ props.platform === 'win32-x64' ? 'zip' : 'tar.gz' }.sha +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'} +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha To update the build scripts and build the release binaries: @@ -39,7 +51,7 @@ To update the build scripts and build the release binaries: git -C ~/Work/xpack-dev-tools/openocd-xpack.git pull && \\ xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ \\ -xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run docker-build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm run deep-clean --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run docker-prepare --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run docker-build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} diff --git a/website/docs/maintainer/_common/_platform-native-build.mdx b/website/docs/maintainer/_common/_platform-native-build.mdx index 9d9f1c0..fbd3ff0 100644 --- a/website/docs/maintainer/_common/_platform-native-build.mdx +++ b/website/docs/maintainer/_common/_platform-native-build.mdx @@ -5,31 +5,43 @@ import CodeBlock from '@theme/CodeBlock'; import customField from '@site/src/libs/customField'; -import { developmentDurations } from '../_development-durations.mdx' +import {developmentDurations} from '../_development-durations.mdx' {/* ------------------------------------------------------------------------ */} +To check the available space: + +```sh +xpm run check-space -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +``` + +To free the space used by all previous builds of all `xpack-dev-tools` packages: + +```sh +xpm run clear-all-project-builds -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +``` + To update the build scripts and build the development binaries: { -`rm -f ~/Work/xpack-dev-tools/openocd-xpack.git/package-lock.json && \\ +`rm -f ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets/package-lock.json && \\ git -C ~/Work/xpack-dev-tools/openocd-xpack.git pull && \\ xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \\ xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \\ xpm run link-deps -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ \\ -xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm run deep-clean --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm install --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} -{ developmentDurations[ props.platform ] }, the output of the build script is a compressed +{developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{ props.platform }/deploy folder: +the buils-assets/build/{props.platform}/deploy folder: -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.tar.gz -* xpack-openocd-{ customField('upstreamVersion') }-{ customField('xpackSubversion') }-{ props.platform }.tar.gz.sha +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.tar.gz +* xpack-openocd-{customField('upstreamVersion')}-{customField('xpackSubversion')}-{props.platform}.tar.gz.sha To update the build scripts and build the release binaries: @@ -38,7 +50,7 @@ To update the build scripts and build the release binaries: git -C ~/Work/xpack-dev-tools/openocd-xpack.git pull && \\ xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ \\ -xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ -xpm run build --config ${ props.platform } -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets` -} +xpm run deep-clean --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm install --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets && \\ +xpm run build --config ${props.platform} -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +`} diff --git a/website/docs/maintainer/_first-development-run.mdx b/website/docs/maintainer/_first-development-run.mdx new file mode 100644 index 0000000..2a39939 --- /dev/null +++ b/website/docs/maintainer/_first-development-run.mdx @@ -0,0 +1,2 @@ + +{/* ------------------------------------------------------------------------ */} diff --git a/website/docs/maintainer/_first-production-run.mdx b/website/docs/maintainer/_first-production-run.mdx new file mode 100644 index 0000000..2a39939 --- /dev/null +++ b/website/docs/maintainer/_first-production-run.mdx @@ -0,0 +1,2 @@ + +{/* ------------------------------------------------------------------------ */} diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index 9ca7065..7197dff 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -9,19 +9,24 @@ date: 2024-07-12 20:11:00 +0300 --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + import CodeBlock from '@theme/CodeBlock'; import customField from '@site/src/libs/customField'; +import isXpackSubversionDouble from '@site/src/libs/isXpackSubversionDouble'; import MoreRepos from './_more-repos.mdx'; -import ReleaseSchedule from './_release-schedule.mdx'; +import ReleaseSchedule from '../getting-started/_release-schedule.mdx'; import CheckUpstreamRelease from './_check-upstream-release.mdx' import UpdateVersionSpecific from './_update-version-specific.mdx' import GitHubActionsDurations from './_github-actions-durations.mdx' import MoreTests from './_more-tests.mdx' import ShareCustom from './_share-custom.mdx' - -import { developmentDurations } from './_development-durations.mdx' +import FirstDevelopmentRun from './_first-development-run.mdx' +import FirstProductionRun from './_first-production-run.mdx' +import {developmentDurations} from './_development-durations.mdx' import Patches from './_patches.mdx' import PlatformNativeBuild from './_common/_platform-native-build.mdx' @@ -33,9 +38,9 @@ import PlatformDockerBuild from './_common/_platform-docker-build.mdx' [![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/openocd-xpack.svg)](https://github.com/xpack-dev-tools/openocd-xpack/issues/) [![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/openocd-xpack.svg)](https://github.com/xpack-dev-tools/openocd-xpack/pulls) -This page is intended for those who maintain +This page is intended for those who maintain the **xPack OpenOCD** -and documents how to make new releases. +project and documents how to make new releases. ## Prerequisites @@ -125,7 +130,13 @@ In the `xpack-dev-tools/openocd-xpack` Git repo: - switch to the `xpack-development` branch - pull new changes -- if needed, merge the `website` branch +- if necessary, merge the `website` branch + +:::caution + +This is really important, otherwise the next steps will build again the previous release! + +::: The `xpack` branch should be unchanged since the previous release and will be updated when the new release is out. @@ -135,29 +146,17 @@ and will be updated when the new release is out. Check the latest versions at https://github.com/xpack-dev-tools/ and update the dependencies in `build-assets/package.json`. - - -### Fix possible open issues - -Check GitHub issues and pull requests: - -- https://github.com/xpack-dev-tools/openocd-xpack/issues/ - -and fix them; assign them to a milestone (like { customField('upstreamVersion') }-{ customField('xpackSubversion') }). +### Increase the version and update it in the top `package.json` -### Increase the version and update VERSION - -Determine the version (like { customField('upstreamVersion') }) -and update the `build-assets/scripts/VERSION` file; the format -is { customField('upstreamVersion') }-{ customField('xpackSubversion') }. -The fourth number is the xPack release number -of this version. A fifth number will be added to the version in `package.json` -when the package is published to the `npm` server. +- determine the version (like {customField('upstreamVersion')}) +- update the version in top `package.json` +- use the new version, suffixed by `.pre`, +like {customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')}.pre. -### Update the version in top `package.json` to a pre-release +### Update the `customFields` in `build-assets/package.json` (if necessary) -Use the new version, suffixed by `.pre`, -like { customField('upstreamVersion') }-{ customField('xpackSubversion') }.{ customField('npmSubversion') }.pre. +If the project uses `customFields` in `build-assets/package.json`, +update them. ### Start the local web server @@ -171,16 +170,42 @@ or run the following in a terminal: Navigate to the **Maintainer Info** page, the **Update the version specific code** section. +### Increase the version and update VERSION + +Determine the version (like {customField('upstreamVersion')}) +and update the `build-assets/scripts/VERSION` file; the format +is {customField('upstreamVersion')}-{customField('xpackSubversion')}. +{isXpackSubversionDouble() ? +'The fourth & fifth numbers are the xPack release number of this version. A sixth number will be added to the version in `package.json` when the package is published to the `npm` server' : +'The fourth number is the xPack release number of this version. A fifth number will be added to the version in `package.json` when the package is published to the `npm` server'}. + + + +### Update the `customFields` (if necessary) + +If the project uses `customFields` in `build-assets/package.json` + +- update the release specific properties (if any) +- restart the local web server + +### Fix possible open issues + +Check GitHub issues and pull requests: + +- https://github.com/xpack-dev-tools/openocd-xpack/issues/ + +and fix them; assign them to a milestone (like {customField('upstreamVersion')}-{customField('xpackSubversion')}). + ### Update `CHANGELOG.md` - open the `CHANGELOG.md` file - check if all previous fixed issues are in -- add a new entry like _**\* v{ customField('upstreamVersion') }-{ customField('xpackSubversion') } prepared**_ -- commit with a message like _**prepare v{ customField('upstreamVersion') }-{ customField('xpackSubversion') }**_ +- add a new entry like _**\* v{customField('upstreamVersion')}-{customField('xpackSubversion')} prepared**_ +- commit with a message like _**prepare v{customField('upstreamVersion')}-{customField('xpackSubversion')}**_ -### Push the changes to Git +### Push the changes to the `xpack-development` branch Be sure that the latest commit that updates `VERSION` is pushed to the `xpack-development` branch! @@ -199,11 +224,13 @@ arm64 GNU/Linux, arm GNU/Linux, x64 macOS and arm64 macOS). Before the real build, run test builds on all platforms. -### Visual Studio Code + + +### Visual Studio Code extension All actions are defined as **xPack actions** and can be conveniently triggered via the VS Code graphical interface, using the -[xPack extension](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack). +[xPack C/C++ Managed Build Tools extension](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack). @@ -220,6 +247,12 @@ machines: sudo systemctl restart docker ``` +### Check if both projects are pushed + +Check if both the current project and the helper are +on the `xpack-development` branch and the latest +commits are pushed to GitHub. + ### Build the x64 macOS binaries For x64 macOS, first run the build on the development machine @@ -230,7 +263,7 @@ export XBB_ENVIRONMENT_SKIP_CHECKS="y" ``` ```sh -rm -f ~/Work/xpack-dev-tools/openocd-xpack.git/package-lock.json +rm -f ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets/package-lock.json git -C ~/Work/xpack-dev-tools/openocd-xpack.git pull xpm run install -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets @@ -251,7 +284,7 @@ For a debug build: xpm run build-development-debug --config darwin-x64 -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets ``` -The build takes { developmentDurations["work"] }. +The build takes {developmentDurations["work"]}. When functional, push the `xpack-development` branch to GitHub. @@ -328,8 +361,11 @@ Copy the trees displayed at the end of the test builds and paste to - `website/docs/install/_miscellaneous.mdx` -Replace **{ customField('upstreamVersion') }** with -`${ customField('upstreamVersion') }`. +Replace **{customField('upstreamVersion')}** with the following expression: + +```txt +${customField('upstreamVersion')} +``` :::tip @@ -339,7 +375,7 @@ via HomeBrew, and make a link to `/usr/local/bin`. ::: -### Update the list of links in package.json +### Update the list of links in top package.json Copy/paste the full list of links displayed at the end of the build, in sequence, for each platform (GNU/Linux, macOS, Windows), and check the @@ -347,6 +383,13 @@ differences compared to the repository. Commit if necessary. +### Update the durations of the development builds + +In `website/docs/maintainer/_development-durations.mdx`, update +the durations of the builds. + +Commit if necessary. + ### How to build a debug version In some cases it is necessary to run a debug session with the binaries. @@ -373,7 +416,6 @@ place them in the XBB cache (`Work/cache`) and restart the build. The automation is provided by GitHub Actions and three self-hosted runners. - ### Start the self-hosted runners - on the development machine (`wksi`) open ssh sessions to the build @@ -442,23 +484,44 @@ Use the message **build-assets/package.json: bump deps**. ### Check for disk space Check if the build machines have enough free space and eventually -do some cleanups - -GNU/Linux: +do some cleanups: ```sh -df -BG -H / +xpm run check-space -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets ``` -macOS: +This is equivalent to running a `df` command. + + + + + ``` df -gH / ``` -To free the space used by previous builds: + + + + +```sh +df -BG -H / +``` + + + + + +To free the space used by all previous builds of all `xpack-dev-tools` packages: ```sh -rm -rf ~/Work/xpack-dev-tools/*/build-assets/build ~/Work/xpack-dev-tools/*/build +xpm run clear-all-project-builds -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-assets +``` + +This is equivalent to running a wide `rm` to remove the `build` folders: + +```sh +rm -rf ~/Work/xpack-dev-tools/*/build-assets/build ``` ### Generate the GitHub workflows @@ -473,7 +536,9 @@ xpm run generate-workflows -C ~/Work/xpack-dev-tools/openocd-xpack.git/build-ass ### Commit and push - commit with the message **Re-generate workflows** -- push the `xpack-dependency` branch to GitHub +- push the `xpack-development` branch to GitHub + + ### Manually trigger the build GitHub Actions @@ -591,10 +656,10 @@ xattr -cr ${HOME}/Downloads/xpack-* ## Publish the release -### Create a new GitHub pre-release draft +### Create a new GitHub pre-release - in `CHANGELOG.md`, add the release date and a message - like _**\* v{ customField('upstreamVersion') }-{ customField('xpackSubversion') } released**_ + like _**\* v{customField('upstreamVersion')}-{customField('xpackSubversion')} released**_ - commit with _**CHANGELOG update**_ - check and possibly update the `build-assets/templates/body-github-release-liquid.mdx` - push the `xpack-development` branch to GitHub @@ -609,12 +674,18 @@ The workflow result and logs are available from the The result is a [draft pre-release](https://github.com/xpack-dev-tools/openocd-xpack/releases/) -tagged like **v{ customField('upstreamVersion') }-{ customField('xpackSubversion') }** (mind the dash in the middle!) and -named like **xPack OpenOCD v{ customField('upstreamVersion') }-{ customField('xpackSubversion') }** (mind the dash), +tagged like **v{customField('upstreamVersion')}-{customField('xpackSubversion')}** (mind the dash in the middle!) and +named like **xPack OpenOCD v{customField('upstreamVersion')}-{customField('xpackSubversion')}** (mind the dash), with all binaries attached. - edit the draft and attach it to the `xpack-development` branch (important!) -- save the draft (do **not** publish yet!) +- perform the final edits and check if everything is fine +- **keep the pre-release button enabled** +- do **not** enable Discussions yet +- click the **Publish release** button + +Note: at this moment the system should send a notification to all clients +watching this project. ### Prepare a new blog post @@ -628,18 +699,8 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/openocd-xpack.git/b - edit the front matter properties - select the correct summary -- commit with _**blog post release { customField('upstreamVersion') }-{ customField('xpackSubversion') } published**_ +- commit with _**blog post release {customField('upstreamVersion')}-{customField('xpackSubversion')} published**_ -### Create the GitHub pre-release - -- go to the [GitHub Releases](https://github.com/xpack-dev-tools/openocd-xpack/releases/) page -- perform the final edits and check if everything is fine -- **keep the pre-release button enabled** -- do not enable Discussions yet -- click the **Publish release** button - -Note: at this moment the system should send a notification to all clients -watching this project. ### Update the web install page @@ -648,7 +709,7 @@ watching this project. - `website/docs/install/_manual-install-quick-test.mdx` - commit changes -### Check the list of links in package.json +### Check the list of links in top package.json - open the `package.json` file - check if the links in the `bin` property cover the actual binaries @@ -657,6 +718,7 @@ watching this project. ### Update the package.json list of binaries - select the `xpack-development` branch +- be sure that the binaries were attached to the pre-release - run the **update-package-binaries** xPack action: ```sh @@ -670,14 +732,14 @@ xpm run update-package-binaries -C ~/Work/xpack-dev-tools/openocd-xpack.git/buil - compare the SHA sums with those shown by `cat *.sha` - check the executable names - commit all changes, use a message like - _**package.json: update urls for { customField('upstreamVersion') }-{ customField('xpackSubversion') }.{ customField('npmSubversion') } release**_ + _**package.json: update urls for {customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')} release**_ ### Publish on the npmjs.com server - select the `xpack-development` branch - check the latest commits `npm run git-log` -- update `CHANGELOG.md`, add a line like _**\* v{ customField('upstreamVersion') }-{ customField('xpackSubversion') } published on npmjs.com**_ -- commit with a message like _**CHANGELOG: publish npm v{ customField('upstreamVersion') }-{ customField('xpackSubversion') }.{ customField('npmSubversion') }**_ +- update `CHANGELOG.md`, add a line like _**\* v{customField('upstreamVersion')}-{customField('xpackSubversion')} published on npmjs.com**_ +- commit with a message like _**CHANGELOG: publish npm v{customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')}**_ - `npm pack` and check the content of the archive, which should list only the `package.json`, the `README.md`, `LICENSE` and `CHANGELOG.md`; possibly adjust `.npmignore` @@ -685,7 +747,7 @@ xpm run update-package-binaries -C ~/Work/xpack-dev-tools/openocd-xpack.git/buil GitHub release; the fifth number is the npm specific version: { -`npm version ${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') } +`npm version ${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')} `} - the commits and the tag should have been pushed by the `postversion` script; @@ -734,15 +796,15 @@ When the release is considered stable, promote it as `latest`: { `npm dist-tag ls @xpack-dev-tools/openocd -npm dist-tag add @xpack-dev-tools/openocd@${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') } latest -npm dist-tag ls @xpack-dev-tools/openocd` -} +npm dist-tag add @xpack-dev-tools/openocd@${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')} latest +npm dist-tag ls @xpack-dev-tools/openocd +`} -In case the previous version is not functional and needs to be unpublished: +In case the release proves problematic and needs to be unpublished: { -`npm unpublish @xpack-dev-tools/openocd@${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }` -} +`npm unpublish @xpack-dev-tools/openocd@${customField('upstreamVersion')}-${customField('xpackSubversion')}.${customField('npmSubversion')} +`} ### Build the static website locally @@ -767,7 +829,7 @@ and the X/Twitter announcement The `website` branch may be subsequently updated, as long as the version in `package.json` is not changed. -### Update the repo main branch +### Update the `xpack` branch - merge `xpack-development` into `xpack` - push the `xpack` branch to GitHub @@ -815,7 +877,7 @@ The results are available from the - in a separate browser windows, open [X/Twitter](https://twitter.com) - using the **`@xpack_project`** account -- paste the release name like _**xPack OpenOCD v{ customField('upstreamVersion') }-{ customField('xpackSubversion') } released**_ +- paste the release name like _**xPack OpenOCD v{customField('upstreamVersion')}-{customField('xpackSubversion')} released**_ - paste the link to the blog post [release](https://xpack.github.io/openocd/releases/) - click the **Tweet** button @@ -829,7 +891,7 @@ The results are available from the [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/latest/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/openocd-xpack/total.svg)](https://github.com/xpack-dev-tools/openocd-xpack/releases/) - previous GNU MCU Eclipse all releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/total.svg)](https://github.com/gnu-mcu-eclipse/openocd/releases/) - - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped per release) + - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=openocd-xpack) (grouped by release) - npmjs.com [`@xpack-dev-tools/openocd`](https://www.npmjs.com/package/@xpack-dev-tools/openocd/) xPack - latest release, per month [![npm (scoped)](https://img.shields.io/npm/v/@xpack-dev-tools/openocd.svg)](https://www.npmjs.com/package/@xpack-dev-tools/openocd/) diff --git a/website/docs/releases/index.md b/website/docs/releases/index.md index 297e210..9316ea2 100644 --- a/website/docs/releases/index.md +++ b/website/docs/releases/index.md @@ -11,7 +11,7 @@ date: 2020-09-28 17:53:00 +0300 --- -import { ReleasesList } from '@site/src/components/ReleasesList'; +import {ReleasesList} from '@site/src/components/ReleasesList'; {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx index f9f88d5..87303fe 100644 --- a/website/docs/support/index.mdx +++ b/website/docs/support/index.mdx @@ -9,7 +9,7 @@ date: 2020-09-28 17:54:00 +0300 --- -import CheckDocumentation from './_check-documentation.mdx'; +import Documentation from '../getting-started/_documentation.mdx'; {/* ------------------------------------------------------------------------ */} @@ -23,17 +23,17 @@ The quick answer is to use the As usual, before anything, it is a good idea to check the project documentation. - + ## Preliminary checks -Before posting any questions, check if the subject was not -already addressed. +Before posting any questions or providing feedback, +check if the subject was not already addressed. - check the [FAQ](/docs/faq/) for similar problems - check the [GitHub Discussions](https://github.com/xpack-dev-tools/openocd-xpack/discussions/) for -similar problems +similar topics - check the [GitHub Issues](https://github.com/xpack-dev-tools/openocd-xpack/issues/) tracker for similar problems. @@ -44,7 +44,7 @@ If you still could not find a solution, if you have interesting use cases, if you have custom configurations, and generally if you have any experience that you want to share with others, use the [GitHub Discussions](https://github.com/xpack-dev-tools/openocd-xpack/discussions/) pages, -and enter a **New discussion**; use the **Q&A** category for questions. +and enter a **New discussion**; use the **Q&A** category for questions, **Ideas** for suggestions and **General** for anything else. ## Register a new support ticket only if necessary diff --git a/website/docs/test/index.mdx b/website/docs/test/index.mdx index ad0b972..1e08ec8 100644 --- a/website/docs/test/index.mdx +++ b/website/docs/test/index.mdx @@ -132,8 +132,8 @@ const visit = require('unist-util-visit'); --- 
{
-`$ tree -L 2 /home/ilg/.local/xPacks/arm-none-eabi-gcc/xpack-arm-none-eabi-gcc-${ version }-${ xpackSubversion }
-/home/ilg/.local/xPacks/arm-none-eabi-gcc/xpack-arm-none-eabi-gcc-${ version }-${ xpackSubversion }
+`$ tree -L 2 /home/ilg/.local/xPacks/arm-none-eabi-gcc/xpack-arm-none-eabi-gcc-${version}-${xpackSubversion}
+/home/ilg/.local/xPacks/arm-none-eabi-gcc/xpack-arm-none-eabi-gcc-${version}-${xpackSubversion}
 ├── arm-none-eabi
 │   ├── bin
 │   ├── include
diff --git a/website/docs/user/_common/_arm-toolchain-versioning.mdx b/website/docs/user/_common/_arm-toolchain-versioning.mdx
new file mode 100644
index 0000000..3d51c09
--- /dev/null
+++ b/website/docs/user/_common/_arm-toolchain-versioning.mdx
@@ -0,0 +1,40 @@
+
+{/* ------------------------------------------------------------------------ */}
+
+import CodeBlock from '@theme/CodeBlock';
+import Admonition from '@theme/Admonition';
+
+import customField from '@site/src/libs/customField';
+
+import LinksVsForwarders from '@site/src/components/LinksVsForwarders'
+
+import versionMajor from '@site/src/libs/versionMajor';
+import versionMinor from '@site/src/libs/versionMinor';
+
+{/* ------------------------------------------------------------------------ */}
+
+## Versioning
+
+The version string used by the
+upstream **Arm GNU Toolchain** project is a bit unusual and unstable in time,
+(like {versionMajor()}.{versionMinor()}.Rel1)
+therefore the upstream GCC version is prefered, which
+is a three number string
+like {customField('upstreamVersion')};
+to this string the xPack distribution adds a fourth number that represents
+the Arm release with the same GCC release, and a fifth number
+that represents the xPack release of the same Arm release;
+since [SemVer](https://semver.org) allows only three numbers,
+all additional ones can
+be added only as pre-release strings, separated by a dash,
+like {customField('upstreamVersion')}-{customField('xpackSubversion')}. When
+published as a npm package, the version gets
+a sixth number,
+like {customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')}.
+
+Since adherence of third party packages to SemVer is not guaranteed,
+it is recommended to avoid referring to the xPack GNU AArch64 Embedded GCC dependency via
+a SemVer expressions
+like ^{customField('upstreamVersion')} or ~{customField('upstreamVersion')}, and
+prefer exact matches,
+like {customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')}.
diff --git a/website/docs/user/_common/_versioning.mdx b/website/docs/user/_common/_versioning.mdx
index 1450346..608e9c2 100644
--- a/website/docs/user/_common/_versioning.mdx
+++ b/website/docs/user/_common/_versioning.mdx
@@ -13,21 +13,21 @@ import LinksVsForwarders from '@site/src/components/LinksVsForwarders'
 ## Versioning
 
 The version string used by the
-upstream { props.upstreamName ? props.upstreamName : 'OpenOCD' } project
+upstream {props.upstreamName ? props.upstreamName : 'OpenOCD'} project
 is a three number string
-like { customField('upstreamVersion') };
+like {customField('upstreamVersion')};
 to this string the xPack distribution adds a fourth number,
 but since [SemVer](https://semver.org) allows only three numbers,
 all additional ones can
 be added only as pre-release strings, separated by a dash,
-like { customField('upstreamVersion') }-{ customField('xpackSubversion') }. When
+like {customField('upstreamVersion')}-{customField('xpackSubversion')}. When
 published as a npm package, the version gets
 a fifth number,
-like { customField('upstreamVersion') }-{ customField('xpackSubversion') }.{ customField('npmSubversion') }.
+like {customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')}.
 
 Since adherence of third party packages to SemVer is not guaranteed,
 it is recommended to avoid referring to the xPack OpenOCD dependency via
 a SemVer expressions
-like ^{ customField('upstreamVersion') } or ~{ customField('upstreamVersion') }, and
+like ^{customField('upstreamVersion')} or ~{customField('upstreamVersion')}, and
 prefer exact matches,
-like { customField('upstreamVersion') }-{ customField('xpackSubversion') }.{ customField('npmSubversion') }.
+like {customField('upstreamVersion')}-{customField('xpackSubversion')}.{customField('npmSubversion')}.
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
index fda9b4a..987c046 100644
--- a/website/docusaurus.config.ts
+++ b/website/docusaurus.config.ts
@@ -1,8 +1,8 @@
 // DO NOT EDIT!
 // Automatically generated from xbb-helper/templates/docusaurus/common.
 
-import { themes as prismThemes } from 'prism-react-renderer';
-import type { Config } from '@docusaurus/types';
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
 import logger from '@docusaurus/logger';
 
@@ -11,7 +11,7 @@ import logger from '@docusaurus/logger';
 // so the entire initialisation code must be in this file, that is
 // not processed by webpack.
 
-import { fileURLToPath } from 'node:url';
+import {fileURLToPath} from 'node:url';
 import path from 'node:path';
 import fs from 'node:fs';
 
@@ -25,14 +25,21 @@ function getCustomFields() {
   const topFileContent = fs.readFileSync(topFilePath);
 
   const topPackageJson = JSON.parse(topFileContent.toString());
-  const jsonVersion = topPackageJson.version.replace(".pre", "");
+  const jsonVersion = topPackageJson.version.replace(/[.-]pre/, '');
 
   logger.info(`package version: ${topPackageJson.version}`);
 
+  // Remove the first part, up to the last dot.
   const npmSubversion = jsonVersion.replace(/^.*[.]/, '');
+
+  // Remove from the last dot to the end.
   const rest1 = jsonVersion.replace(/[.][0-9]*$/, '');
+
+  // Remove the first part, up to the dash.
   const xpackSubversion = rest1.replace(/^.*[-]/, '');
-  const upstreamVersion = rest1.replace(/[-][0-9]*$/, '');
+
+  // Remove from the dash to the end.
+  const upstreamVersion = rest1.replace(/[-].*$/, '');
 
   let rootPackageJson
   try {
@@ -44,12 +51,16 @@ function getCustomFields() {
     rootPackageJson = topPackageJson;
   }
 
+  const customFields = rootPackageJson?.xpack?.properties?.customFields ?? {};
+
   return {
     appName: rootPackageJson.xpack.properties.appName,
     appLcName: rootPackageJson.xpack.properties.appLcName,
+    version: jsonVersion,
     upstreamVersion,
     xpackSubversion,
     npmSubversion,
+    ...customFields,
   }
 }
 
diff --git a/website/src/components/HomepageFeatures/index.tsx b/website/src/components/HomepageFeatures/index.tsx
index 3625bc1..a265904 100644
--- a/website/src/components/HomepageFeatures/index.tsx
+++ b/website/src/components/HomepageFeatures/index.tsx
@@ -67,9 +67,9 @@ const FeatureList: FeatureItem[] = [
 function Feature({title, Svg, description}: FeatureItem) {
   return (
     

-      { 

+      

         
-      
 }
+      

       

         {title}
         
{description}

diff --git a/website/src/components/InstallWithCopy/index.tsx b/website/src/components/InstallWithCopy/index.tsx
index 7976171..0f5cf03 100644
--- a/website/src/components/InstallWithCopy/index.tsx
+++ b/website/src/components/InstallWithCopy/index.tsx
@@ -15,7 +15,7 @@
 import React from 'react';
 import CodeBlock from '@theme/CodeBlock';
 
-export default function InstallWithCopy({ children }): JSX.Element {
+export default function InstallWithCopy({children}): JSX.Element {
     return (
         
             {children}
diff --git a/website/src/components/ReleasesList/index.tsx b/website/src/components/ReleasesList/index.tsx
index 9165f63..786cae2 100644
--- a/website/src/components/ReleasesList/index.tsx
+++ b/website/src/components/ReleasesList/index.tsx
@@ -12,11 +12,11 @@
  * be obtained from https://opensource.org/licenses/MIT/.
  */
 
-import { usePluginData } from '@docusaurus/useGlobalData';
+import {usePluginData} from '@docusaurus/useGlobalData';
 import logger from '@docusaurus/logger'
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
-export function ReleasesList({ items }): JSX.Element {
+export function ReleasesList({items}): JSX.Element {
   const pluginData = usePluginData('select-releases');
 
   pluginData.releasesTable.forEach((item) => logger.info(item))
@@ -25,7 +25,7 @@ export function ReleasesList({ items }): JSX.Element {
       {
         pluginData.releasesTable.map(release => (
           
  • 
-            { release.title } (download)
+            {release.title} (download)
           
    • 
         ))
       }
diff --git a/website/src/libs/isXpackSubversionDouble.js b/website/src/libs/isXpackSubversionDouble.js
new file mode 100644
index 0000000..9ac76cd
--- /dev/null
+++ b/website/src/libs/isXpackSubversionDouble.js
@@ -0,0 +1,19 @@
+/*
+ * DO NOT EDIT!
+ * Automatically generated from xbb-helper/templates/docusaurus/common.
+ *
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2024 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+import customField from '@site/src/libs/customField';
+
+export default function isXpackSubversionDouble() {
+  return (customField('xpackSubversion').indexOf('.') !== -1);
+}
diff --git a/website/src/libs/versionMajor.js b/website/src/libs/versionMajor.js
index e9b5c08..b9fc61d 100644
--- a/website/src/libs/versionMajor.js
+++ b/website/src/libs/versionMajor.js
@@ -15,5 +15,6 @@
 import customField from '@site/src/libs/customField';
 
 export default function getVersionMajor() {
+  // Remove from the first dot to the end.
   return parseInt(customField('upstreamVersion').replace(/[.].*/, ''), 10);
 }
diff --git a/website/src/libs/versionMinor.js b/website/src/libs/versionMinor.js
new file mode 100644
index 0000000..5cb62b1
--- /dev/null
+++ b/website/src/libs/versionMinor.js
@@ -0,0 +1,21 @@
+/*
+ * DO NOT EDIT!
+ * Automatically generated from xbb-helper/templates/docusaurus/common.
+ *
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2024 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+import customField from '@site/src/libs/customField';
+
+export default function getVersionMinor() {
+  // Remove from the beginning to the first dot and, in the remaining string
+  // from the first dot to the end.
+  return parseInt(customField('upstreamVersion').replace(/^[0-9]*[.]/, '').replace(/[.].*/, ''), 10);
+}
diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx
index be7dbcc..ceed0e5 100644
--- a/website/src/pages/index.tsx
+++ b/website/src/pages/index.tsx
@@ -22,7 +22,7 @@ import HomepageFeatures from '@site/src/components/HomepageFeatures';
 import InstallWithCopy from '@site/src/components/InstallWithCopy';
 
 function HomepageHeader() {
-  const { siteConfig } = useDocusaurusContext();
+  const {siteConfig} = useDocusaurusContext();
   return (
     
    
       
    
@@ -39,7 +39,7 @@ function HomepageHeader() {
 }
 
 export default function Home(): JSX.Element {
-  const { siteConfig } = useDocusaurusContext();
+  const {siteConfig} = useDocusaurusContext();
   return (
     
 
 
-
-
-
\ No newline at end of file
+
+
+
diff --git a/website/static/img/globe.svg b/website/static/img/globe.svg
index 06039bb..ccdc838 100644
--- a/website/static/img/globe.svg
+++ b/website/static/img/globe.svg
@@ -1,8 +1,8 @@
 
 
 
-
-
-
-
-
\ No newline at end of file
+
+
+
+
+
diff --git a/website/static/img/mosaic.svg b/website/static/img/mosaic.svg
index 446fb84..bbea8aa 100644
--- a/website/static/img/mosaic.svg
+++ b/website/static/img/mosaic.svg
@@ -1,8 +1,8 @@
 
 
 
-
-
-
-
-
\ No newline at end of file
+
+
+
+
+