diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 56c9f78aa..ad2cf5a5f 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -4,21 +4,18 @@ on: push: branches: [main, master] paths: ['doc/**'] + pull_request: + paths: ['doc/**'] concurrency: - group: ${{ github.workflow }} + group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: - DeployDocs: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} + Build: runs-on: ubuntu-latest permissions: contents: read - pages: write - id-token: write steps: - name: Checkout actions uses: actions/checkout@v4 @@ -35,6 +32,18 @@ jobs: with: path: doc/site + DeployDocs: + needs: Build + if: github.event_name == 'push' + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + permissions: + contents: read + pages: write + id-token: write + steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 diff --git a/doc/docs/api-reference/cpp/core-classes/container.md b/doc/docs/api-reference/cpp/core-classes/container.md index c9d988a96..3c967064b 100644 --- a/doc/docs/api-reference/cpp/core-classes/container.md +++ b/doc/docs/api-reference/cpp/core-classes/container.md @@ -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. diff --git a/doc/docs/api-reference/cpp/core-classes/process.md b/doc/docs/api-reference/cpp/core-classes/process.md index 47d6f187c..0165b5282 100644 --- a/doc/docs/api-reference/cpp/core-classes/process.md +++ b/doc/docs/api-reference/cpp/core-classes/process.md @@ -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`. diff --git a/doc/docs/api-reference/cpp/core-classes/session.md b/doc/docs/api-reference/cpp/core-classes/session.md index 4517695f3..edca3446d 100644 --- a/doc/docs/api-reference/cpp/core-classes/session.md +++ b/doc/docs/api-reference/cpp/core-classes/session.md @@ -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"); ``` diff --git a/doc/docs/api-reference/cpp/data-classes/containernamedvolume.md b/doc/docs/api-reference/cpp/data-classes/containernamedvolume.md index 13134ff96..9d4e7a771 100644 --- a/doc/docs/api-reference/cpp/data-classes/containernamedvolume.md +++ b/doc/docs/api-reference/cpp/data-classes/containernamedvolume.md @@ -3,6 +3,7 @@ Attaches a named session VHD volume to a container. **Constructors / properties** + - `ContainerNamedVolume(hstring name, hstring containerPath, bool readOnly)` - `Name()` / setter - `ContainerPath()` / setter diff --git a/doc/docs/api-reference/cpp/data-classes/containerportmapping.md b/doc/docs/api-reference/cpp/data-classes/containerportmapping.md index 1e2fa10df..3f86302c2 100644 --- a/doc/docs/api-reference/cpp/data-classes/containerportmapping.md +++ b/doc/docs/api-reference/cpp/data-classes/containerportmapping.md @@ -3,6 +3,7 @@ Maps a Windows host port to a container port. **Constructors / properties** + - `ContainerPortMapping(uint16_t windowsPort, uint16_t containerPort, PortProtocol protocol)` - `WindowsPort()` / setter - `ContainerPort()` / setter @@ -10,6 +11,7 @@ Maps a Windows host port to a container port. - `WindowsAddress()` / setter **Important notes** + - `WindowsAddress` is implemented. - The setter accepts only `Windows::Networking::HostName` values whose type is `Ipv4` or `Ipv6`. - `ToStruct()` uses `inet_pton` and stores a real `sockaddr_in` / `sockaddr_in6`. diff --git a/doc/docs/api-reference/cpp/data-classes/containervolume.md b/doc/docs/api-reference/cpp/data-classes/containervolume.md index 90b7f0617..528eabc5d 100644 --- a/doc/docs/api-reference/cpp/data-classes/containervolume.md +++ b/doc/docs/api-reference/cpp/data-classes/containervolume.md @@ -3,6 +3,7 @@ Binds a Windows path into the container. **Constructors / properties** + - `ContainerVolume(hstring windowsPath, hstring containerPath, bool readOnly)` - `WindowsPath()` / setter - `ContainerPath()` / setter diff --git a/doc/docs/api-reference/cpp/data-classes/imageinfo.md b/doc/docs/api-reference/cpp/data-classes/imageinfo.md index bfa8a7199..5fb1c9abb 100644 --- a/doc/docs/api-reference/cpp/data-classes/imageinfo.md +++ b/doc/docs/api-reference/cpp/data-classes/imageinfo.md @@ -3,6 +3,7 @@ Read-only wrapper created from `WslcImageInfo`. **Properties** + - `Name()` → image name - `Sha256()` → 32-byte buffer - `Size()` → image size diff --git a/doc/docs/api-reference/cpp/data-classes/imageprogress.md b/doc/docs/api-reference/cpp/data-classes/imageprogress.md index c4e33be6a..7c73e13ed 100644 --- a/doc/docs/api-reference/cpp/data-classes/imageprogress.md +++ b/doc/docs/api-reference/cpp/data-classes/imageprogress.md @@ -3,6 +3,7 @@ Progress item reported by image pull/import/load/push operations. **Properties** + - `Id()` - `Status()` - `CurrentBytes()` diff --git a/doc/docs/api-reference/cpp/data-classes/installprogress.md b/doc/docs/api-reference/cpp/data-classes/installprogress.md index ce074048c..4c543aaa4 100644 --- a/doc/docs/api-reference/cpp/data-classes/installprogress.md +++ b/doc/docs/api-reference/cpp/data-classes/installprogress.md @@ -3,6 +3,7 @@ Progress item reported by `WslcService::InstallWithDependenciesAsync()`. **Properties** + - `Component()` - `Progress()` - `Total()` diff --git a/doc/docs/api-reference/cpp/delegates-and-events/processcrashhandler.md b/doc/docs/api-reference/cpp/delegates-and-events/processcrashhandler.md index fd129b096..5131ee135 100644 --- a/doc/docs/api-reference/cpp/delegates-and-events/processcrashhandler.md +++ b/doc/docs/api-reference/cpp/delegates-and-events/processcrashhandler.md @@ -1,6 +1,7 @@ # ProcessCrashHandler Observed use: + - `Session::ProcessCrashed` raises one `ProcessCrashInformation` argument. ```cpp diff --git a/doc/docs/api-reference/cpp/delegates-and-events/processexithandler.md b/doc/docs/api-reference/cpp/delegates-and-events/processexithandler.md index 6d554003c..0faac1ae9 100644 --- a/doc/docs/api-reference/cpp/delegates-and-events/processexithandler.md +++ b/doc/docs/api-reference/cpp/delegates-and-events/processexithandler.md @@ -1,6 +1,7 @@ # ProcessExitHandler Observed use: + - `Process::Exited` raises one `int32_t exitCode`. ```cpp diff --git a/doc/docs/api-reference/cpp/delegates-and-events/processoutputhandler.md b/doc/docs/api-reference/cpp/delegates-and-events/processoutputhandler.md index 09c147694..ceceeaeb7 100644 --- a/doc/docs/api-reference/cpp/delegates-and-events/processoutputhandler.md +++ b/doc/docs/api-reference/cpp/delegates-and-events/processoutputhandler.md @@ -1,6 +1,7 @@ # ProcessOutputHandler Observed use: + - `Process::OutputReceived` and `Process::ErrorReceived` raise one argument containing raw output bytes. - The wrapper forwards a `winrt::array_view` produced from the C callback buffer. diff --git a/doc/docs/api-reference/cpp/delegates-and-events/sessionterminationhandler.md b/doc/docs/api-reference/cpp/delegates-and-events/sessionterminationhandler.md index 819def451..f9da6d4e4 100644 --- a/doc/docs/api-reference/cpp/delegates-and-events/sessionterminationhandler.md +++ b/doc/docs/api-reference/cpp/delegates-and-events/sessionterminationhandler.md @@ -1,6 +1,7 @@ # SessionTerminationHandler Observed use: + - `Session::Terminated` raises one argument: `SessionTerminationReason reason`. ```cpp diff --git a/doc/docs/api-reference/cpp/enumerations/component.md b/doc/docs/api-reference/cpp/enumerations/component.md index 2631758e7..e2145aa52 100644 --- a/doc/docs/api-reference/cpp/enumerations/component.md +++ b/doc/docs/api-reference/cpp/enumerations/component.md @@ -3,6 +3,7 @@ `WslcService::GetMissingComponents()` returns a `Component` bitmask. Underlying values: + - `VirtualMachinePlatform = 1` - `WslPackage = 2` - `SdkNeedsUpdate = 4` diff --git a/doc/docs/api-reference/cpp/enumerations/containernetworkingmode.md b/doc/docs/api-reference/cpp/enumerations/containernetworkingmode.md index bf16ab935..bea0baa9d 100644 --- a/doc/docs/api-reference/cpp/enumerations/containernetworkingmode.md +++ b/doc/docs/api-reference/cpp/enumerations/containernetworkingmode.md @@ -1,10 +1,12 @@ # ContainerNetworkingMode `winrt_ContainerSettings.cpp` explicitly validates only: + - `None` - `Bridged` Underlying C values: + - `None = 0` - `Bridged = 1` diff --git a/doc/docs/api-reference/cpp/enumerations/containerstate.md b/doc/docs/api-reference/cpp/enumerations/containerstate.md index e53b67201..1fbb89e2b 100644 --- a/doc/docs/api-reference/cpp/enumerations/containerstate.md +++ b/doc/docs/api-reference/cpp/enumerations/containerstate.md @@ -3,6 +3,7 @@ `Container::State()` casts directly from `WslcContainerState`. Underlying C values: + - `Invalid = 0` - `Created = 1` - `Running = 2` diff --git a/doc/docs/api-reference/cpp/enumerations/deletecontaineroption.md b/doc/docs/api-reference/cpp/enumerations/deletecontaineroption.md index 7d73e9b79..2b510b72a 100644 --- a/doc/docs/api-reference/cpp/enumerations/deletecontaineroption.md +++ b/doc/docs/api-reference/cpp/enumerations/deletecontaineroption.md @@ -3,6 +3,7 @@ `Container::Delete()` takes `DeleteContainerOption`. Underlying values: + - `None = 0` - `Force = 1` diff --git a/doc/docs/api-reference/cpp/enumerations/error.md b/doc/docs/api-reference/cpp/enumerations/error.md index 3cae7c6a8..9f4987adc 100644 --- a/doc/docs/api-reference/cpp/enumerations/error.md +++ b/doc/docs/api-reference/cpp/enumerations/error.md @@ -1,6 +1,7 @@ # Error Underlying HRESULT values: + - `ImageNotFound = -2147219967` - `ContainerPrefixAmbiguous = -2147219966` - `ContainerNotFound = -2147219965` diff --git a/doc/docs/api-reference/cpp/enumerations/imageprogressstatus.md b/doc/docs/api-reference/cpp/enumerations/imageprogressstatus.md index f2f263168..49a4ff1c8 100644 --- a/doc/docs/api-reference/cpp/enumerations/imageprogressstatus.md +++ b/doc/docs/api-reference/cpp/enumerations/imageprogressstatus.md @@ -3,6 +3,7 @@ `ImageProgress` casts directly from `WslcImageProgressStatus`. Underlying C values: + - `Unknown = 0` - `Pulling = 1` - `Waiting = 2` diff --git a/doc/docs/api-reference/cpp/enumerations/portprotocol.md b/doc/docs/api-reference/cpp/enumerations/portprotocol.md index 5d28408ec..f466c2263 100644 --- a/doc/docs/api-reference/cpp/enumerations/portprotocol.md +++ b/doc/docs/api-reference/cpp/enumerations/portprotocol.md @@ -4,6 +4,7 @@ - The value is passed directly to `WslcContainerPortMapping::protocol`. Underlying C values: + - `TCP = 0` - `UDP = 1` diff --git a/doc/docs/api-reference/cpp/enumerations/processoutputhandle.md b/doc/docs/api-reference/cpp/enumerations/processoutputhandle.md index 657c2dc97..69650f097 100644 --- a/doc/docs/api-reference/cpp/enumerations/processoutputhandle.md +++ b/doc/docs/api-reference/cpp/enumerations/processoutputhandle.md @@ -1,6 +1,7 @@ # ProcessOutputHandle `Process::GetOutputStream(ProcessOutputHandle)` accepts these values: + - `StandardOutput = 1` - `StandardError = 2` diff --git a/doc/docs/api-reference/cpp/enumerations/processoutputmode.md b/doc/docs/api-reference/cpp/enumerations/processoutputmode.md index 9925bf8e7..80d52abec 100644 --- a/doc/docs/api-reference/cpp/enumerations/processoutputmode.md +++ b/doc/docs/api-reference/cpp/enumerations/processoutputmode.md @@ -1,11 +1,13 @@ # ProcessOutputMode Underlying values: + - `Discard = 0` - `Stream = 1` - `Event = 2` Behavior: + - `Discard`: no stdout/stderr events or output streams. - `Stream`: `GetOutputStream(...)` can be used. - `Event`: stdout/stderr are delivered by callbacks and `OutputReceived` / `ErrorReceived`. diff --git a/doc/docs/api-reference/cpp/enumerations/processstate.md b/doc/docs/api-reference/cpp/enumerations/processstate.md index 7158af33c..d24cd2df6 100644 --- a/doc/docs/api-reference/cpp/enumerations/processstate.md +++ b/doc/docs/api-reference/cpp/enumerations/processstate.md @@ -3,6 +3,7 @@ `Process::State()` casts directly from `WslcProcessState`. Underlying C values: + - `Unknown = 0` - `Running = 1` - `Exited = 2` diff --git a/doc/docs/api-reference/cpp/enumerations/sessionterminationreason.md b/doc/docs/api-reference/cpp/enumerations/sessionterminationreason.md index 7a9acebf9..dc97fb5af 100644 --- a/doc/docs/api-reference/cpp/enumerations/sessionterminationreason.md +++ b/doc/docs/api-reference/cpp/enumerations/sessionterminationreason.md @@ -3,6 +3,7 @@ `Session::OnTerminated` converts `WslcSessionTerminationReason` directly to the WinRT enum. Underlying C values: + - `Unknown = 0` - `Shutdown = 1` - `Crashed = 2` diff --git a/doc/docs/api-reference/cpp/enumerations/signal.md b/doc/docs/api-reference/cpp/enumerations/signal.md index a78cd591f..3195adc7f 100644 --- a/doc/docs/api-reference/cpp/enumerations/signal.md +++ b/doc/docs/api-reference/cpp/enumerations/signal.md @@ -3,6 +3,7 @@ `Container::Stop()` and `Process::Signal()` cast directly to `WslcSignal`. Underlying values: + - `None = 0` - `SIGHUP = 1` - `SIGINT = 2` diff --git a/doc/docs/api-reference/cpp/enumerations/vhdtype.md b/doc/docs/api-reference/cpp/enumerations/vhdtype.md index 3a6bbfa93..9d43a474a 100644 --- a/doc/docs/api-reference/cpp/enumerations/vhdtype.md +++ b/doc/docs/api-reference/cpp/enumerations/vhdtype.md @@ -1,6 +1,7 @@ # VhdType Underlying values: + - `Dynamic = 0` - `Fixed = 1` diff --git a/doc/docs/api-reference/cpp/service-class/wslcservice.md b/doc/docs/api-reference/cpp/service-class/wslcservice.md index 50b0232c8..fdfe6b39f 100644 --- a/doc/docs/api-reference/cpp/service-class/wslcservice.md +++ b/doc/docs/api-reference/cpp/service-class/wslcservice.md @@ -3,12 +3,14 @@ Static entry points over the service-level C API. **Methods** + - `GetMissingComponents()` - `GetVersion()` - `InstallWithDependencies()` - `InstallWithDependenciesAsync()` **Behavior notes** + - `GetMissingComponents()` returns a `Component` bitmask. - `GetVersion()` returns a `ServiceVersion` constructed from `major`, `minor`, and `revision`. - `InstallWithDependencies()` installs dependencies synchronously. diff --git a/doc/docs/api-reference/cpp/settings-classes/containersettings.md b/doc/docs/api-reference/cpp/settings-classes/containersettings.md index 02c40e0d1..bcedb4430 100644 --- a/doc/docs/api-reference/cpp/settings-classes/containersettings.md +++ b/doc/docs/api-reference/cpp/settings-classes/containersettings.md @@ -1,10 +1,12 @@ # ContainerSettings **Constructor** + - `ContainerSettings(hstring imageName)` - `imageName` must be non-empty. **Properties** + - `ImageName()` / setter - `Name()` / setter - `InitProcess()` / setter @@ -19,6 +21,7 @@ - `NamedVolumes()` / setter **Important notes** + - Collection setters reject `nullptr`. - When converting to the C struct, null elements inside the collections are rejected. diff --git a/doc/docs/api-reference/cpp/settings-classes/processsettings.md b/doc/docs/api-reference/cpp/settings-classes/processsettings.md index d93050bfb..d2a5367d5 100644 --- a/doc/docs/api-reference/cpp/settings-classes/processsettings.md +++ b/doc/docs/api-reference/cpp/settings-classes/processsettings.md @@ -1,12 +1,14 @@ # ProcessSettings **Properties** + - `WorkingDirectory()` / setter - `CommandLine()` / setter - `EnvironmentVariables()` / setter - `OutputMode()` / setter **Important notes** + - `CommandLine(nullptr)` and `EnvironmentVariables(nullptr)` are rejected. - `Process::Start()` later requires a **non-empty** `CommandLine()`. - `ProcessOutputMode::Event` installs C callbacks; `ProcessOutputMode::Stream` expects stream access; `Discard` is the default. diff --git a/doc/docs/api-reference/cpp/settings-classes/sessionsettings.md b/doc/docs/api-reference/cpp/settings-classes/sessionsettings.md index 8348b332d..5002c9305 100644 --- a/doc/docs/api-reference/cpp/settings-classes/sessionsettings.md +++ b/doc/docs/api-reference/cpp/settings-classes/sessionsettings.md @@ -1,11 +1,13 @@ # SessionSettings **Constructor** + - `SessionSettings(hstring name, hstring storagePath)` - `name` must be non-empty. - `storagePath` must be non-empty. **Properties** + - `Name()` / setter - `StoragePath()` / setter - `CpuCount()` / setter (`0` rejected) diff --git a/doc/docs/api-reference/cpp/settings-classes/vhdoptions.md b/doc/docs/api-reference/cpp/settings-classes/vhdoptions.md index 8d507cdde..c8cc558fd 100644 --- a/doc/docs/api-reference/cpp/settings-classes/vhdoptions.md +++ b/doc/docs/api-reference/cpp/settings-classes/vhdoptions.md @@ -1,6 +1,7 @@ # VhdOptions **Properties** + - `Name()` / setter - `Size()` / setter - `Type()` / setter diff --git a/doc/docs/api-reference/csharp/core-classes/container.md b/doc/docs/api-reference/csharp/core-classes/container.md index 534b44066..382099798 100644 --- a/doc/docs/api-reference/csharp/core-classes/container.md +++ b/doc/docs/api-reference/csharp/core-classes/container.md @@ -19,6 +19,7 @@ public sealed class Container : IDisposable ``` Notes: + - `Start()` has **no flags parameter**. - If `InitProcess.OutputMode` is `Event` or `Stream`, `Start()` automatically requests native attach. - `InitProcess` is only available when `ContainerSettings.InitProcess` was configured. diff --git a/doc/docs/api-reference/csharp/core-classes/process.md b/doc/docs/api-reference/csharp/core-classes/process.md index f66816599..bd0d14367 100644 --- a/doc/docs/api-reference/csharp/core-classes/process.md +++ b/doc/docs/api-reference/csharp/core-classes/process.md @@ -23,6 +23,7 @@ public sealed class Process ``` Notes: + - Call `Start()` only for **secondary processes** created by `Container.CreateProcess(...)`. - The init process is started by `Container.Start()`. - `OutputReceived` and `ErrorReceived` require `OutputMode.Event`. diff --git a/doc/docs/api-reference/csharp/data-classes/containerportmapping.md b/doc/docs/api-reference/csharp/data-classes/containerportmapping.md index 14a44d9fb..7a62c15be 100644 --- a/doc/docs/api-reference/csharp/data-classes/containerportmapping.md +++ b/doc/docs/api-reference/csharp/data-classes/containerportmapping.md @@ -17,6 +17,7 @@ public sealed class ContainerPortMapping ``` Notes: + - `WindowsAddress` **is implemented**. - It accepts only `HostNameType.Ipv4` and `HostNameType.Ipv6` values. - DNS names are rejected. diff --git a/doc/docs/api-reference/csharp/settings-classes/containersettings.md b/doc/docs/api-reference/csharp/settings-classes/containersettings.md index 433e8e3d3..33d2df013 100644 --- a/doc/docs/api-reference/csharp/settings-classes/containersettings.md +++ b/doc/docs/api-reference/csharp/settings-classes/containersettings.md @@ -23,6 +23,7 @@ public sealed class ContainerSettings ``` Notes: + - `PortMappings`, `Volumes`, and `NamedVolumes` are mutable collections. - `InitProcess` is optional. - `NetworkingMode` is nullable; `null` means “leave default behavior”. diff --git a/doc/docs/api-reference/csharp/settings-classes/processsettings.md b/doc/docs/api-reference/csharp/settings-classes/processsettings.md index 5e14f3778..410c66a96 100644 --- a/doc/docs/api-reference/csharp/settings-classes/processsettings.md +++ b/doc/docs/api-reference/csharp/settings-classes/processsettings.md @@ -13,6 +13,7 @@ public sealed class ProcessSettings ``` Notes: + - `CommandLine` must be non-empty before calling `Process.Start()`. - The init process is started by `Container.Start()`, not by `Process.Start()`. - `OutputMode.Event` enables `OutputReceived` / `ErrorReceived`. diff --git a/doc/docs/api-reference/csharp/settings-classes/sessionsettings.md b/doc/docs/api-reference/csharp/settings-classes/sessionsettings.md index 29c7db108..95336f800 100644 --- a/doc/docs/api-reference/csharp/settings-classes/sessionsettings.md +++ b/doc/docs/api-reference/csharp/settings-classes/sessionsettings.md @@ -18,6 +18,7 @@ public sealed class SessionSettings ``` Notes: + - `CpuCount`, `MemorySizeInMB`, and `Timeout` are optional nullable values. - `Timeout` must be positive and must fit in a `uint32` millisecond count. - `VhdRequirements` is optional. diff --git a/doc/docs/api-reference/csharp/settings-classes/vhdoptions.md b/doc/docs/api-reference/csharp/settings-classes/vhdoptions.md index ac18a9ea3..dfd5f4665 100644 --- a/doc/docs/api-reference/csharp/settings-classes/vhdoptions.md +++ b/doc/docs/api-reference/csharp/settings-classes/vhdoptions.md @@ -15,6 +15,7 @@ public sealed class VhdOptions ``` Notes: + - Use `SessionSettings.VhdRequirements` for session-level storage requirements. - Use `Session.CreateVhdVolume(...)` for named session volumes. - `Owner` is intended for named-volume creation and is rejected on `SessionSettings.VhdRequirements`. diff --git a/doc/docs/debugging.md b/doc/docs/debugging.md index 12a011f2c..247d5980f 100644 --- a/doc/docs/debugging.md +++ b/doc/docs/debugging.md @@ -15,6 +15,7 @@ wpr -stop logs.ETL ``` The consolidated `wsl.wprp` file includes multiple profiles for different scenarios: + - `WSL` - General WSL tracing (default) - `WSL-Storage` - Enhanced storage tracing - `WSL-Networking` - Comprehensive networking tracing