lee/container
1
0
Fork 0
mirror of https://github.com/apple/container.git synced 2026-09-11 10:15:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Source code documentation updates (#9)

Browse Source 
This change adds documentation to quite a few existing public types that
didn't have a blurb before.

Additionally, this fixes a couple things that I think either didn't make
sense when going to document them:
- Rename ConnectionStream to VsockConnectionStream. This type only
functions for vsock connections.
- Deletes NsLock+Closure. This was not used anywhere.
- Rename ContainerizationOCI/Config.swift to ImageConfig.swift.

Signed-off-by: Danny Canter <danny_canter@apple.com>
This commit is contained in:
Danny Canter
2025-06-05 16:16:18 -07:00
committed by Kathryn Baldauf
parent 8d880efc36
commit 6bc4bf5124
36 changed files with 98 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/Containerization/VirtualMachineInstance.swift
+1 -1
View File
@@ -39,7 +39,7 @@ public protocol VirtualMachineInstance: Sendable {
/// Dial a vsock port in the guest.
func dial(_ port: UInt32) async throws -> FileHandle
/// Listen on a host vsock port.
func listen(_ port: UInt32) throws -> ConnectionStream
func listen(_ port: UInt32) throws -> VsockConnectionStream
/// Stop listening on a vsock port.
func stopListen(_ port: UInt32) throws
/// Start the virtual machine.