Skip to content

Commit 926e7ef

Browse files
General Project Update
- Updated build script for Windows - [doc] Updated documentation on: --> compile instructions --> release preparation steps --> list of supported devices --> OS version support status
1 parent b05a117 commit 926e7ef

File tree

5 files changed

+16
-47
lines changed

5 files changed

+16
-47
lines changed

doc/compiling.md

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,14 @@ On Windows users should ensure that the following software is installed:
1616
1. Install `git` from <https://git-scm.com/download/win>
1717
2. Install `cmake` from <https://cmake.org/download><br />
1818
Ensure that you add cmake to the $PATH system variable when following the instructions by the setup assistant.
19-
3. Install
20-
21-
- _EITHER_: Download **MinGW-w64** from <hhttp://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/8.1.0/threads-win32/sjlj/x86_64-8.1.0-release-win32-sjlj-rt_v6-rev0.7z>. Extract content to `C:\mingw-w64\` and add `C:\mingw-w64\bin\` to PATH-Variable.<br />
22-
- _OR_: **MSVC toolchain** from Visual Studio Build Tools 2019
19+
3. Install MinGW-w64<br />
20+
Download **MinGW-w64** from <https://github.com/niXman/mingw-builds-binaries/releases/download/13.2.0-rt_v11-rev1/x86_64-13.2.0-release-win32-seh-msvcrt-rt_v11-rev1.7z>. Extract content to `C:\mingw-w64\` and add `C:\mingw-w64\bin\` to PATH-Variable.<br />
2321

2422
4. Create a new destination folder at a place of your choice
2523
5. Open the command-line (cmd.exe) and execute `cd C:\$Path-to-your-destination-folder$\`
2624
6. Fetch the project sourcefiles by running `git clone https://github.com/stlink-org/stlink.git`from the command-line (cmd.exe)<br />
2725
or download and extract the stlink zip-sourcefolder from the Release page on GitHub.
2826

29-
#### MSVC toolchain - minimal installation
30-
31-
Visual Studio IDE is not necessary, only Windows SDK & build tools are required (~3,3GB).
32-
33-
1. Open <https://visualstudio.microsoft.com/downloads/>
34-
2. Navigate through menus as follows (might change overtime)
35-
36-
`All downloads > Tools for Visual Studio 2019 > Build Tools for Visual Studio 2019 > Download`
37-
38-
3. Start downloaded executable. After Visual Studio Installer bootstraps and main window pops up, open `Individual Components` tab, and pick
39-
40-
- latest build tools (eg. `MSVC v142 - VS 2019 C++ x64/x86 build tools (v14.25)`)
41-
- latest Windows SDK (eg. `Windows 10 SDK (10.0.18362.0)`)
42-
43-
4. After installation finishes, you can press `Launch` button in Visual Studio Installer's main menu.
44-
- Thus you can open `Developer Command Prompt for VS 2019`. It is `cmd.exe` instance with adjusted PATHs including eg. `msbuild`.
45-
- Alternatively, you can use `Developer Powershell for VS 2019` which is the same thing for `powershell.exe`. Both are available from Start menu.
46-
- Another option is to add `msbuild` to PATH manually. Its location should be `C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin`. Then, it should be available from any `powershell.exe` or `cmd.exe` session.
47-
4827
### Building
4928

5029
#### MinGW-w64
@@ -58,19 +37,6 @@ Per default the build script (currently) uses `C:\mingw-w64\x86_64-8.1.0-release
5837
When installing different toolchains make sure to update the path in the `mingw64-build.bat`.<br />
5938
This can be achieved by opening the .bat file with a common text editor.
6039

61-
#### MSVC toolchain
62-
63-
1. In a command prompt, change the directory to the folder where the stlink files were cloned (or unzipped) to.
64-
2. Make sure the build folder exists (`mkdir build` if not).
65-
3. From the build folder, run cmake (`cd build; cmake ..`).
66-
67-
This will create a solution file `stlink.sln` in the build folder.
68-
Now, you can build whole `stlink` suite using following command:
69-
70-
```
71-
msbuild /m /p:Configuration=Release stlink.sln
72-
```
73-
7440
Options:
7541

7642
- `/m` - compilation runs in parallel utilizing multiple cores

doc/release.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ Release
33

44
This document describes the necessary steps for developers to create a release:
55

6-
1. Update `CHANGELOG.md`, `cmake/packaging/deb/changelog` & `cmake/packaging/rpm/changelog`
6+
1. Update changelog (`CHANGELOG.md`, `cmake/packaging/deb/changelog` & `cmake/packaging/rpm/changelog`)
77
2. Update `.version` with semantic version: `x.x.x`
88
3. Update `README.md` with semantic version `x.x.x` in commits badge
9-
4. Merge `develop` into `master`
10-
5. Create and push git tag and commits `git tag x.x.x`
11-
6. Create binary packages (.rpm / .deb / .zip) with `make package && sh ./cmake/packaging/windows/generate_binaries.sh`
12-
7. Upload packages to the [release page](https://github.com/stlink-org/stlink/releases) of this project
13-
8. Merge `master` into `develop`
14-
9. Update GitHub security policy (/SECURITY.md)
9+
4. Update GitHub security policy (`SECURITY.md`)
10+
5. Merge `develop` into `master`
11+
6. Create and push git tag and commits `git tag x.x.x`
12+
7. Create binary packages (.rpm / .deb / .zip) with `make package && sh ./cmake/packaging/windows/generate_binaries.sh`
13+
8. Upload packages to the [release page](https://github.com/stlink-org/stlink/releases) of this project
14+
9. Merge `master` into `develop`

doc/supported_devices.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,13 @@ More commonly these are:
3030
| STM32F4 | M4F | |
3131
| STM32G4 | M4F | |
3232
| STM32L4 | M4F | |
33-
| STM32F7 | M4F | |
34-
| STM32H7 | M4F | |
33+
| STM32F7 | M7F | |
34+
| STM32H7 | M7F | |
3535
| STM32WB | M4F | |
3636
| STM32WL | M4 | |
37+
| STM32L5 | M33 | |
38+
| STM32H5 | M33 | |
39+
| STM32U5 | M33 | |
3740

3841

3942
# Chinese Clone-Chips [may work, but without support!]

doc/version_support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ Other Linux-/Unix-based Operating Systems:
3434
| Ubuntu 20.04 LTS (Focal) | 1.0.23 | 3.**16.3** | 3.24.**18** | May 2025 |
3535
| | | | | |
3636
| FreeBSD 13.x | 1.0.**16-18** (API 0x01000102) | 3.22.1 | 3.24.31 | |
37-
| FreeBSD 12.x | 1.0.**16-18** (API 0x01000102) | 3.22.1 | 3.24.31 | Dec 2023 |
3837
| | | | | |
3938
| NetBSD 9.x | 1.0.24 | 3.21.2 | 3.24.30 | |
4039
| NetBSD 8.x | 1.0.24 | 3.**19.7** | 3.24.27 | |
@@ -60,6 +59,7 @@ Systems with highlighted versions remain compatible with this toolset.
6059

6160
| Operating System | libusb | cmake | End of<br />OS-Support |
6261
| ---------------------------------------- | ------------------------------ | ---------- | ---------------------- |
62+
| FreeBSD 12.x | 1.0.**16-18** (API 0x01000102) | 3.**22.1** | Dec 2023 |
6363
| Alpine 3.15 | 1.0.**24** | 3.**21.3** | Nov 2023 |
6464
| Fedora 35 [x64] | 1.0.**24** | 3.**21.3** | Dec 2022 |
6565
| Alpine 3.14 | 1.0.**24** | 3.**20.3** | May 2023 |

mingw64-build.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
mkdir build-mingw
44
cd build-mingw
5-
set PATH=C:\Program Files (x86)\CMake\bin;C:\Program Files\CMake\bin;C:\mingw-w64\x86_64-8.1.0-win32-sjlj-rt_v6-rev0\mingw64\bin;%PATH%
5+
set PATH=C:\Program Files\CMake\bin;C:\mingw-w64\x86_64-13.2.0-release-win32-seh-msvcrt-rt_v11-rev1\mingw64\bin;%PATH%
66
cmake -G "MinGW Makefiles" ..
77
mingw32-make
88
mingw32-make install

0 commit comments

Comments
 (0)