Skip to content

Commit fda0922

Browse files
committed
Fix rendering of Dev Containers docs
1 parent 4316544 commit fda0922

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

doc/dev_containers.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Dev Container for short) allows a container to be used as a full‑featured
88
development environment.
99

1010
Stack provides the following Dev Containers:
11+
1112
* a default Dev Container, intended for use with Stack's project‑level
1213
configuration (`stack.yaml`); and
1314
* alternative Dev Containers, intended for use with Stack's experimental
@@ -63,6 +64,7 @@ These Docker images are multi-architecture (`linux/amd64`, `linux/arm64/v8`)
6364

6465
The images contain *unofficial* binary distributions of GHC 9.4.6 and 9.6.2
6566
(that is, ones not released by the GHC developers). That is because:
67+
6668
1. the official GHC binary distributions for Alpine Linux/x86_64 have known
6769
bugs; and
6870
2. there are no official binary distributions for Alpine Linux/AArch64.
@@ -82,19 +84,19 @@ For use with Github Codespaces, please follow the instruction at
8284

8385
Data in the following locations is persisted:
8486

85-
1. The user's home directory (`/home/vscode`)[^2]
87+
1. The user's home directory (`/home/vscode` or, for the root user, `/root`).
88+
Use with Docker/Podman in *rootless mode*.
8689
2. The Dev Container's workspace (`/workspaces`)
8790

88-
[^2]: Alternatively for the root user (`/root`). Use with Docker/Podman in
89-
*rootless mode*.
90-
91-
This is accomplished either via a *volume* or *bind mount* (or *loop device*
91+
This is accomplished via either a *volume* or *bind mount* (or *loop device*
9292
on Codespaces) and is preconfigured.
9393

9494
!!! info
9595

96-
**Codespaces: A 'Full Rebuild Container' resets the home directory.**
97-
This is never necessary unless you want exactly that.
96+
The VS Code Command Palette command
97+
['Codespaces: Full Rebuild Container'](https://docs.github.com/en/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#rebuilding-a-container)
98+
resets the home directory. This is never necessary unless you want exactly
99+
that.
98100

99101
## Build Stack
100102

0 commit comments

Comments
 (0)