Skip to content

Commit 5fe900f

Browse files
committed
environments: hide legacy environments by default, add a changelog
New users don't need to know about them, since they are currently phased out. To give some context on when environments were added/removed add a changelog with some links for extra context. To enable the tabbed content feature enable the mkdocs plugin for it.
1 parent c9794f1 commit 5fe900f

File tree

2 files changed

+32
-9
lines changed

2 files changed

+32
-9
lines changed

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ markdown_extensions:
6666
- codehilite
6767
- sane_lists
6868
- admonition
69+
- pymdownx.tabbed:
70+
alternate_style: true
6971
- pymdownx.arithmatex
7072
- pymdownx.betterem:
7173
smart_enable: all

web/docs/environments.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,22 @@ tools.
2121

2222
## Overview
2323

24-
| | Name | Prefix | Toolchain | Architecture | C Library | C++ Library |
25-
|----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
26-
| ![msys](msys.png){: style="max-width:25px" } | **MSYS** | `/usr` | gcc | x86_64 | cygwin | libstdc++ |
27-
| ![ucrt64](ucrt64.png){: style="max-width:25px" } | **UCRT64** | `/ucrt64` | gcc | x86_64 | ucrt | libstdc++ |
28-
| ![clang64](clang64.png){: style="max-width:25px" } | **CLANG64** | `/clang64` | llvm | x86_64 | ucrt | libc++ |
29-
| ![clangarm64](clangarm64.png){: style="max-width:25px" } | **CLANGARM64** | `/clangarm64` | llvm | aarch64 | ucrt | libc++ |
30-
| ![clang32](clang32.png){: style="max-width:25px" } | **CLANG32** | `/clang32` | llvm | i686 | ucrt | libc++ |
31-
| ![mingw64](mingw64.png){: style="max-width:25px" } | **MINGW64** | `/mingw64` | gcc | x86_64 | msvcrt | libstdc++ |
32-
| ![mingw32](mingw32.png){: style="max-width:25px" } | **MINGW32** | `/mingw32` | gcc | i686 | msvcrt | libstdc++ |
24+
=== "Environments"
25+
26+
| | Name | Prefix | Toolchain | Architecture | C Library | C++ Library |
27+
|----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
28+
| ![msys](msys.png){: style="max-width:25px" } | **MSYS** | `/usr` | gcc | x86_64 | cygwin | libstdc++ |
29+
| ![ucrt64](ucrt64.png){: style="max-width:25px" } | **UCRT64** | `/ucrt64` | gcc | x86_64 | ucrt | libstdc++ |
30+
| ![clang64](clang64.png){: style="max-width:25px" } | **CLANG64** | `/clang64` | llvm | x86_64 | ucrt | libc++ |
31+
| ![clangarm64](clangarm64.png){: style="max-width:25px" } | **CLANGARM64** | `/clangarm64` | llvm | aarch64 | ucrt | libc++ |
32+
| ![mingw64](mingw64.png){: style="max-width:25px" } | **MINGW64** | `/mingw64` | gcc | x86_64 | msvcrt | libstdc++ |
33+
34+
=== "Legacy Environments"
35+
36+
| | Name | Prefix | Toolchain | Architecture | C Library | C++ Library |
37+
|----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
38+
| ![clang32](clang32.png){: style="max-width:25px" } | **CLANG32** | `/clang32` | llvm | i686 | ucrt | libc++ |
39+
| ![mingw32](mingw32.png){: style="max-width:25px" } | **MINGW32** | `/mingw32` | gcc | i686 | msvcrt | libstdc++ |
3340

3441
The active environment is selected via the `MSYSTEM` environment variable.
3542
Setting `MSYSTEM` to `UCRT64` and starting a login shell will put you in that
@@ -87,3 +94,17 @@ code was compiled with MSVC.
8794
and Windows Server 2016 or later. For older Windows versions, you have to
8895
provide it explicitly or depend on the user having it installed. More
8996
information about that can be found in [UCRT deployment](https://learn.microsoft.com/en-us/cpp/windows/universal-crt-deployment).
97+
98+
## Changelog
99+
100+
**2023-12-13:** Start of phase out for 32-bit environments, MINGW32 and CLANG32. See [NEWS](../news.md#2023-12-13-starting-to-drop-some-32-bit-packages) for more information.
101+
102+
**2022-12-30:** Added CLANGARM64 environment.
103+
104+
**2022-10-29:** Changed the default environment from MINGW64 to UCRT64. See [NEWS](../news.md#2022-10-29-changing-the-default-environment-from-mingw64-to-ucrt64) for more information.
105+
106+
**2022-05-01:** Added CLANG32 environment.
107+
108+
**2021-03-26:** Added UCRT64 environment.
109+
110+
**2020-05-17:** Dropped 32-bit variant of the MSYS environment. See [NEWS](../news.md#2020-05-17-32-bit-msys2-no-longer-actively-supported) for more information.

0 commit comments

Comments
 (0)