Skip to content

Commit ea8dc6b

Browse files
committed
chore(doc): clarify some usage
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
1 parent 42e4507 commit ea8dc6b

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

_dev/Add-a-new-variant-(board).md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ This means that the generic STM32 MCU files required for a variant are generated
4747
> The example of all the steps below are available in this PR: [Add generic G0B1R(B-C-E)T, G0C1R(C-E)T and Nucleo-G0B1RE ](../pull/1398)
4848
4949
---
50+
51+
> [!TIP]
52+
> If you have any issue with the following guide. Do not hesitate to ask question on the [stm32duino Github discussions](https://github.com/orgs/stm32duino/discussions) or the [stm32duino forum](http://stm32duino.com).
53+
5054
# Define a new generic variant
5155

5256
Before adding a specific board, it is a good practice to add the generic entry of the STM32 MCU as it is possible to use it with the specific board.

_dev/Using-git-repository.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ To use the [Arduino_Core_STM32] git repository instead of the packaged version,
33
## 1. Install the STM32 Core packages
44

55
To get started with development on `main` branch, correct versions of the required dependencies have to be installed (see: [platform.txt](../blob/main/platform.txt)):
6+
67
* [CMSIS](https://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php): ARM® Cortex® Microcontroller Software Interface Standard
78
* [GNU Arm Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm): Arm Embedded GCC compiler, libraries and other GNU tools necessary for bare-metal software development on devices based on the Arm Cortex-M. Packages are provided thanks [The xPack GNU Arm Embedded GCC](https://xpack.github.io/arm-none-eabi-gcc/): https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack
89
* [OpenOCD](https://openocd.org/): the Open On-Chip Debugger provides on-chip programming and debugging support with a layered architecture of JTAG interface and TAP support. Packages are provided thanks [The xPack OpenOCD](https://xpack-dev-tools.github.io/openocd-xpack/): https://github.com/xpack-dev-tools/openocd-xpack
@@ -11,16 +12,18 @@ To get started with development on `main` branch, correct versions of the requir
1112

1213
> [!IMPORTANT]
1314
> Using the git repository requires sometimes to update tools dependencies.
15+
> To check if you need to install new dependencies:
16+
> 1. open the dedicated [package index](https://arduino.github.io/arduino-cli/latest/package_index_json-specification/): [package_stmicroelectronics_index.json](https://github.com/stm32duino/BoardManagerFiles/blob/dev/package_stmicroelectronics_index.json) of the [BoardManagerFiles `dev`](https://github.com/stm32duino/BoardManagerFiles) branch.
17+
> 2. If a version is suffixed by `-dev` it means one or more dependencies have been updated else no change done since the last release, so no need to perform a new installation. Dependencies are already satisfied.
1418
15-
Example when the arm-none-abi-gcc toolchain or the CMSIS version are updated. In that case, all dependencies are available in a dedicated [package index](https://arduino.github.io/arduino-cli/latest/package_index_json-specification/): [package_stmicroelectronics_index.json](https://github.com/stm32duino/BoardManagerFiles/blob/dev/package_stmicroelectronics_index.json) of the [BoardManagerFiles `dev`](https://github.com/stm32duino/BoardManagerFiles) branch.
19+
Example when the arm-none-abi-gcc toolchain or the CMSIS version are updated. New dependencies are added in this dedicated [package index](https://arduino.github.io/arduino-cli/latest/package_index_json-specification/): [package_stmicroelectronics_index.json](https://github.com/stm32duino/BoardManagerFiles/blob/dev/package_stmicroelectronics_index.json) of the [BoardManagerFiles `dev`](https://github.com/stm32duino/BoardManagerFiles) branch.
1620

17-
See the [[Getting Started]] page to see how to install the core and its tools dependencies except you have to use this link in the "Additional Boards Managers URLs" field instead of the one specified:
21+
See the [[Getting Started]] page to see how to install the core and its tools dependencies except you have to use this link in the "Additional Boards Managers URLs" field instead of the one specified if a suffixed `-dev` version exist to install the required dependencies for the `main` branch of the [Arduino_Core_STM32]:
1822

1923
https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/dev/package_stmicroelectronics_index.json
2024

21-
Then install the latest version displayed by the board manager, if a version is suffixed by `-dev` it means one or more dependencies have been updated else no change done since the last release.
22-
23-
This will install the required dependencies for the main branch.
25+
> [!IMPORTANT]
26+
> Here, it is expected you have the core and its tools dependencies installed.
2427
2528
## 2. Delete the stm32 core extracted package
2629

0 commit comments

Comments
 (0)