mirror of
https://github.com/aphrody-labs/WSL.git
synced 2026-10-17 12:45:55 +00:00
Run the documentation pipeline when doc/ is edited + various rendering fixes (#40931)
* Run the documentation pipeline when doc/ is edited + various rendering fixes * Fix inverted condition
This commit is contained in:
40 files changed
+71
-11
No files matched your search
@@ -1,6 +1,7 @@
|
||||
# Container
|
||||
|
||||
**Methods**
|
||||
|
||||
- `Start()`
|
||||
- `Stop(Signal signal, TimeSpan timeout)`
|
||||
- `Delete(DeleteContainerOption options)`
|
||||
@@ -12,6 +13,7 @@
|
||||
- `Close()`
|
||||
|
||||
**Behavior notes**
|
||||
|
||||
- `Start()` automatically sets `WSLC_CONTAINER_START_FLAG_ATTACH` if an init process exists and its output mode is `Event` or `Stream`.
|
||||
- `Stop()` converts the timeout to **seconds**, rejects negative values, and rejects values that exceed `uint32_t`.
|
||||
- `InitProcess()` throws if the container was not configured with one.
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
`Process` objects are returned by `Container::CreateProcess()` and `Container::InitProcess()`.
|
||||
|
||||
**Methods / events**
|
||||
|
||||
- `Start()`
|
||||
- `Signal(Signal signal)`
|
||||
- `GetOutputStream(ProcessOutputHandle outputHandle)`
|
||||
@@ -16,6 +17,7 @@
|
||||
- `Close()`
|
||||
|
||||
**Behavior notes**
|
||||
|
||||
- `Start()` cannot be called on the init process.
|
||||
- `Start()` requires a non-empty `ProcessSettings::CommandLine()`.
|
||||
- `GetOutputStream()` requires `ProcessOutputMode::Stream`.
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
# Session
|
||||
|
||||
**Constructor**
|
||||
|
||||
- `Session(SessionSettings settings)`
|
||||
- rejects `nullptr` settings.
|
||||
|
||||
**Methods**
|
||||
|
||||
- `Start()`
|
||||
- `Terminate()`
|
||||
- `CreateContainer(ContainerSettings containerSettings)`
|
||||
@@ -27,6 +29,7 @@
|
||||
- `Close()`
|
||||
|
||||
**Behavior notes**
|
||||
|
||||
- `Start()` is one-shot; calling it twice throws.
|
||||
- Most methods call `EnsureStarted()` first.
|
||||
- `ImportImage` / `ImportImageAsync` and `LoadImage` / `LoadImageAsync` are path-based only.
|
||||
@@ -83,18 +86,18 @@ for (auto const& image : images)
|
||||
```
|
||||
|
||||
```cpp
|
||||
PullImageOptions pullOptions = ;
|
||||
PullImageOptions pullOptions = {};
|
||||
auto pullOp = session.PullImageAsync(pullOptions);
|
||||
pullOp.Progress([](auto&&, ImageProgress const& p) { /* progress */ });
|
||||
co_await pullOp;
|
||||
|
||||
PushImageOptions pushOptions = ;
|
||||
PushImageOptions pushOptions = {};
|
||||
co_await session.PushImageAsync(pushOptions);
|
||||
|
||||
TagImageOptions tagOptions = ;
|
||||
TagImageOptions tagOptions = {};
|
||||
session.TagImage(tagOptions);
|
||||
|
||||
VhdOptions vhdOptions = ;
|
||||
VhdOptions vhdOptions = {};
|
||||
session.CreateVhdVolume(vhdOptions);
|
||||
session.DeleteVhdVolume(L"build-cache");
|
||||
```
|
||||
|
||||
Reference in new issue
Block a user