@micro-os-plus/build-helper/dev-scripts/README.md

A source library xPack to assist the µOS++ builds

# Helper scripts

Maintenance scripts used in other packages.

## Submodule

This project is linked as submodule to:

- devices-stm32f0-extras-xpack.git
- devices-stm32f4-extras-xpack.git

## clone-and-link-all-git-repos.sh

Script to download all source xPacks.

The first argument is an optional destination folder path. The default is
`${HOME}/Work/micro-os-plus-xpack-repos`.

```sh
curl -L https://raw.githubusercontent.com/micro-os-plus/build-helper-xpack/xpack/scripts/clone-and-link-all-git-repos.sh | bash 
```

To get the very latest version, get the script from the
`xpack-develop` branch:

```sh
curl -L https://raw.githubusercontent.com/micro-os-plus/build-helper-xpack/xpack-develop/scripts/clone-and-link-all-git-repos.sh | bash 
```


## generate-vectors-from-arm-startup.sh

Script to generate the vectors_xxx.c files for a family.

It can be invoked with:

```bash
bash generate-vectors-from-arm-startup.sh ${from} ${to}
```

`from` is the path to the CMSIS assembly files, like:

- `${HOME}/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.1/Drivers/CMSIS/Device/ST/STM32F0xx/Source/Templates/arm`

and `to` is the path to the destination folder, like:

- `eclipse-embed-cdt.github/eclipse-plugins.git/plugins/org.eclipse.embedcdt.templates.stm/templates/micro-os-plus/stm32f0.pack/src/cmsis`:

## convert-arm-asm-to-c.sh

Script to convert the Arm assembly file into C.

It can be invoked with:

```bash
bash convert-arm-asm-to-c.sh ${input} >${output}
```

The input file is usually an Arm assembly file from the vendor CMSIS, 
something like:

- `${HOME}/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.1/Drivers/CMSIS/Device/ST/STM32F0xx/Source/Templates/arm/startup_stm32f030x6.s`

---

## Other scripts

- clang-format.sh
- copy-clang-format.sh
- copy-gitignore.sh
- copy-npmignore.sh
- git-merge-develop.sh
- git-pull.sh
- git-push.sh
- git-status.sh
- xpm-link-all.sh

They iterate the .git folders and perform the desired action.