Skip to content

Commit

Permalink
Add a page for repos and mirrors and one for package names
Browse files Browse the repository at this point in the history
To keep the environment overview less overloaded.
  • Loading branch information
lazka committed Jan 16, 2022
1 parent e2fe13a commit 97544b5
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 47 deletions.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ nav:
- docs/terminals.md
- Package Management:
- docs/package-management.md
- docs/package-naming.md
- docs/repos-mirrors.md
- docs/package-management-tips.md
- docs/filesystem-paths.md
- docs/cmake.md
Expand Down
60 changes: 13 additions & 47 deletions web/docs/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,53 +22,19 @@ tools.

## Overview

| | Name [^1] | Prefix | Toolchain | Architecture | Package prefix [^2] | C Library | C++ Library |
| - | - | - | - | - | - | - |- |
| ![msys](msys.png){: style="max-width:25px" } | **MSYS** | `/usr` | gcc | x86_64 | None | cygwin | libstdc++ |
| ![mingw64](mingw64.png){: style="max-width:25px" } | **MINGW64** | `/mingw64` | gcc | x86_64 | `mingw-w64-x86_64-` | msvcrt | libstdc++ |
| ![ucrt64](ucrt64.png){: style="max-width:25px" } | **UCRT64** | `/ucrt64` | gcc | x86_64 | `mingw-w64-ucrt-x86_64-` | ucrt | libstdc++ |
| ![clang64](clang64.png){: style="max-width:25px" } | **CLANG64** | `/clang64` | llvm | x86_64 | `mingw-w64-clang-x86_64-` | ucrt | libc++ |
| ![mingw32](mingw32.png){: style="max-width:25px" } | **MINGW32** | `/mingw32` | gcc | i686 | `mingw-w64-i686-` | msvcrt | libstdc++ |
| ![clang32](clang32.png){: style="max-width:25px" } | **CLANG32** | `/clang32` | llvm | i686 | `mingw-w64-clang-i686-` | ucrt | libc++ |
| ![clangarm64](clangarm64.png){: style="max-width:25px" } | **CLANGARM64** | `/clangarm64` | llvm | aarch64 | `mingw-w64-clang-aarch64-` | ucrt | libc++ |

[^1]: `MSYSTEM`
[^2]: `MINGW_PACKAGE_PREFIX`

## Active environments

The package manager uses only environments that are configured under `/etc/pacman.conf`.
You may add/uncomment/remove/comment those as needed:

```pkgconf
# always include msys!
[msys]
Include = /etc/pacman.d/mirrorlist.msys
[mingw32]
Include = /etc/pacman.d/mirrorlist.mingw
[mingw64]
Include = /etc/pacman.d/mirrorlist.mingw
[ucrt64]
Include = /etc/pacman.d/mirrorlist.mingw
[clang64]
Include = /etc/pacman.d/mirrorlist.mingw
[clang32]
Include = /etc/pacman.d/mirrorlist.mingw
#[clangarm64]
#Include = /etc/pacman.d/mirrorlist.mingw
```

For more details about how to install packages see ['Package Management'](package-management.md).

To launch an environment either use the wrapper executables like `ucrt64.exe` or
call `msys2_shell.cmd` with either the matching parameter like `msys2_shell.cmd -clang64`
or by setting `MSYSTEM`.
| | Name | Prefix | Toolchain | Architecture | C Library | C++ Library |
|----------------------------------------------------------|----------------|---------------|-----------|--------------|-----------|-------------|
| ![msys](msys.png){: style="max-width:25px" } | **MSYS** | `/usr` | gcc | x86_64 | cygwin | libstdc++ |
| ![mingw64](mingw64.png){: style="max-width:25px" } | **MINGW64** | `/mingw64` | gcc | x86_64 | msvcrt | libstdc++ |
| ![ucrt64](ucrt64.png){: style="max-width:25px" } | **UCRT64** | `/ucrt64` | gcc | x86_64 | ucrt | libstdc++ |
| ![clang64](clang64.png){: style="max-width:25px" } | **CLANG64** | `/clang64` | llvm | x86_64 | ucrt | libc++ |
| ![mingw32](mingw32.png){: style="max-width:25px" } | **MINGW32** | `/mingw32` | gcc | i686 | msvcrt | libstdc++ |
| ![clang32](clang32.png){: style="max-width:25px" } | **CLANG32** | `/clang32` | llvm | i686 | ucrt | libc++ |
| ![clangarm64](clangarm64.png){: style="max-width:25px" } | **CLANGARM64** | `/clangarm64` | llvm | aarch64 | ucrt | libc++ |

The active environment is selected via the `MSYSTEM` environment variable.
Setting `MSYSTEM` to `UCRT64` and starting a login shell will put you in that
environment.

## GCC vs LLVM/Clang

Expand Down
11 changes: 11 additions & 0 deletions web/docs/package-naming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Package Naming

| | Package prefix |
|----------------------------------------------------------|----------------------------|
| ![msys](msys.png){: style="max-width:25px" } | None |
| ![mingw64](mingw64.png){: style="max-width:25px" } | `mingw-w64-x86_64-` |
| ![ucrt64](ucrt64.png){: style="max-width:25px" } | `mingw-w64-ucrt-x86_64-` |
| ![clang64](clang64.png){: style="max-width:25px" } | `mingw-w64-clang-x86_64-` |
| ![mingw32](mingw32.png){: style="max-width:25px" } | `mingw-w64-i686-` |
| ![clang32](clang32.png){: style="max-width:25px" } | `mingw-w64-clang-i686-` |
| ![clangarm64](clangarm64.png){: style="max-width:25px" } | `mingw-w64-clang-aarch64-` |
36 changes: 36 additions & 0 deletions web/docs/repos-mirrors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Repositories and Mirrors

## Active environments

The package manager uses only environments that are configured under `/etc/pacman.conf`.
You may add/uncomment/remove/comment those as needed:

```pkgconf
# always include msys!
[msys]
Include = /etc/pacman.d/mirrorlist.msys
[mingw32]
Include = /etc/pacman.d/mirrorlist.mingw
[mingw64]
Include = /etc/pacman.d/mirrorlist.mingw
[ucrt64]
Include = /etc/pacman.d/mirrorlist.mingw
[clang64]
Include = /etc/pacman.d/mirrorlist.mingw
[clang32]
Include = /etc/pacman.d/mirrorlist.mingw
#[clangarm64]
#Include = /etc/pacman.d/mirrorlist.mingw
```

For more details about how to install packages see ['Package Management'](package-management.md).

To launch an environment either use the wrapper executables like `ucrt64.exe` or
call `msys2_shell.cmd` with either the matching parameter like `msys2_shell.cmd -clang64`
or by setting `MSYSTEM`.

0 comments on commit 97544b5

Please sign in to comment.