Skip to content

Commit

Permalink
website: update maintainer & user info
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Aug 3, 2024
1 parent ac6f07b commit 7328638
Show file tree
Hide file tree
Showing 14 changed files with 1,219 additions and 307 deletions.
877 changes: 877 additions & 0 deletions website/docs/maintainer-info/__index.mdx

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions website/docs/maintainer-info/_check-upstream-release.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

{/* ------------------------------------------------------------------------ */}

### Check the latest upstream release

The current upstream release are expected to
be announced in the [OpenOCD](https://openocd.org)
web, and reflected in the Git
[tags](https://sourceforge.net/p/openocd/code/ci/master/tree/).
Compare the latest tag with the current xPack
[release](https://github.com/xpack-dev-tools/openocd-xpack/releases).
If necessary, update the triplet, otherwise increase the fourth number,
as below.
11 changes: 11 additions & 0 deletions website/docs/maintainer-info/_ci-durations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

{/* ------------------------------------------------------------------------ */}

The builds take about 11 minutes to complete:

- `darwin-x64`: 5m (nuc)
- `darwin-arm64`: 4m (m1)
- `linux-x64`: 4m (amd)
- `win32-x64`: 5m (amd)
- `linux-arm64`: 11m (rpi4)
- `linux-arm`: 11m (rpi4)
58 changes: 58 additions & 0 deletions website/docs/maintainer-info/_functional-tests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@

import CodeBlock from '@theme/CodeBlock';

import customField from '@site/src/libs/customField';

{/* ------------------------------------------------------------------------ */}

Functional tests cannot run on CI since they require physical hardware.

For the simplest functional case, plug a common board like the
STM32F4DISCOVERY into an USB port, start the program and check
if the CPU is identified.

Note: If this is the first time openocd is executed, on GNU/Linux
it is necessary
to configure the rights, otherwise LIBUSB will issue the _libusb_open
failed: LIBUSB_ERROR_ACCESS_ error.

<CodeBlock language="sh"> {
`sudo cp ~/Downloads/xpack-openocd-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }/contrib/60-openocd.rules /etc/udev/rules.d
sudo udevadm control --reload-rules`
} </CodeBlock>

Then it is possible to start openocd:

<CodeBlock language="console"> {
`$ .../xpack-openocd-${ customField('upstreamVersion') }-${ customField('xpackSubversion') }/bin/openocd -f "board/stm32f4discovery.cfg"
xPack Open On-Chip Debugger ${ customField('upstreamVersion') }-01004-g9ea7f3d64-dirty
Licensed under GNU GPL v2
For bug reports, read
https://openocd.org/doc/doxygen/bugs.html
Info : The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD
srst_only separate srst_nogate srst_open_drain connect_deassert_srst
Info : Listening on port 6666 for tcl connections
Info : Listening on port 4444 for telnet connections
Info : clock speed 2000 kHz
Info : STLINK V2J39S0 (API v2) VID:PID 0483:3748
Info : Target voltage: 2.901598
Info : [stm32f4x.cpu] Cortex-M4 r0p1 processor detected
Info : [stm32f4x.cpu] target has 6 breakpoints, 4 watchpoints
Info : starting gdb server for stm32f4x.cpu on 3333
Info : Listening on port 3333 for gdb connections
[stm32f4x.cpu] halted due to breakpoint, current mode: Handler HardFault
xPSR: 0x61000003 pc: 0x080002d6 msp: 0x2001ff78
^C
shutdown command invoked`
} </CodeBlock>

Note: on recent macOS systems it might be necessary to allow individual
programs to run.

For a more thorough test, run a debug session with
the Eclipse STM32F4DISCOVERY blinky test
available in the xpack-arm-none-eabi-openocd package, which uses
the `-f "board/stm32f4discovery.cfg"` configuration file
(import the `arm-f4b-fs` project and start the `arm-f4b-fs-debug-oocd`
launcher).
7 changes: 7 additions & 0 deletions website/docs/maintainer-info/_more-repos.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

{/* ------------------------------------------------------------------------ */}

Other repositories in use are:

- https://github.com/openocd-org/openocd.git - a read-only mirror of the
upstream OpenOCD (`git://git.code.sf.net/p/openocd/code`)
10 changes: 10 additions & 0 deletions website/docs/maintainer-info/_release-schedule.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

{/* ------------------------------------------------------------------------ */}

## Release schedule

In the past, the OpenOCD had no release schedule, and very rare
[releases](https://github.com/openocd-org/openocd/releases).
The xPack OpenOCD releases also had no schedules, and were done on an
as-needed basis. As a general rule, it is planned to follow the upstream
releases and add releases from the repo HEAD from time to time.
12 changes: 12 additions & 0 deletions website/docs/maintainer-info/_share-custom.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

import customField from '@site/src/libs/customField';

{/* ------------------------------------------------------------------------ */}

## Share on openocd-user

Send email to <a href="mailto:openocd-user@lists.sourceforge.net">openocd-user@lists.sourceforge.net</a> with:

- Subject: _**xPack OpenOCD v{ customField('upstreamVersion') }-{ customField('xpackSubversion') } released**_
- a link to the blog post
[release]( https://xpack-dev-tools.github.io/openocd-xpack/blog/)
8 changes: 8 additions & 0 deletions website/docs/maintainer-info/_update-version-specific.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

{/* ------------------------------------------------------------------------ */}

### 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 **`XBB_OPENOCD_GIT_COMMIT`** to the desired commit id from the upstream repo
Loading

0 comments on commit 7328638

Please sign in to comment.