docs: enhance SWBBuildService inline documentations (swiftlang#48)

MojtabaHs · web-flow · commit af1840b5b730 · 2025-02-02T10:40:08.000-08:00
* docs: fix spelling of `targeted`

* docs: fix spelling of `service`

* docs: fix spelling of `approach`

* docs: fix spelling of `transferred`
diff --git a/Sources/SWBBuildService/BuildOperationMessages.swift b/Sources/SWBBuildService/BuildOperationMessages.swift
@@ -1095,7 +1095,7 @@ final class OperationDelegate: BuildOperationDelegate {
         // We also send back a snapshot of the information on the target we have, since we are in a better position to retrieve it (rather than force the client to have an immutable cache).
         //
         // FIXME: Compute configurationIsDefault correctly.
-        // FIXME (rdar://53726633): It's really not safe to be using the `target` property off of the `configuredTarget` due to the fact that this can hold old references to project model items if the PIF/build descriptions are re-used, but the project model instances are re-created. This is a targetted fix for rdar://50962080, which should be address more correctly later.
+        // FIXME (rdar://53726633): It's really not safe to be using the `target` property off of the `configuredTarget` due to the fact that this can hold old references to project model items if the PIF/build descriptions are re-used, but the project model instances are re-created. This is a targeted fix for rdar://50962080, which should be address more correctly later.
         guard let target = workspaceContext.workspace.target(for: configuredTarget.target.guid) else {
             preconditionFailure("Unable to find target '\(configuredTarget.target.name)' in workspace '\(workspaceContext.workspace.name)'.")
         }
diff --git a/Sources/SWBBuildService/BuildServiceEntryPoint.swift b/Sources/SWBBuildService/BuildServiceEntryPoint.swift
@@ -89,7 +89,7 @@ extension BuildService {
         }
     }
 
-    /// Common entry point to the build serivce for in-process and out-of-process connectons.
+    /// Common entry point to the build service for in-process and out-of-process connectons.
     ///
     /// Called directly from the exported C entry point `swiftbuildServiceEntryPoint` for in-process connections, or from `BuildService.main()` (after some basic file descriptor setup) for out-of-process connections.
     fileprivate static func run(inputFD: FileDescriptor, outputFD: FileDescriptor, connectionMode: ServiceHostConnectionMode, pluginsDirectory: URL?, arguments: [String], pluginLoadingFinished: () throws -> Void) async throws {
diff --git a/Sources/SWBBuildService/Messages.swift b/Sources/SWBBuildService/Messages.swift
@@ -1256,7 +1256,7 @@ final package class BuildDependencyInfoOperation: InfoOperation, TargetDependenc
 ///
 /// Presently this involves getting the target build phase for the request, and then for each target extracting configuration info as well as relevant inputs and outputs that target declares.
 ///
-/// In the future this could perform a full task construction and examine the individual tasks to get a more complete set of information, but that apporach is hypothetical at this time.
+/// In the future this could perform a full task construction and examine the individual tasks to get a more complete set of information, but that approach is hypothetical at this time.
 private struct DumpBuildDependencyInfoMsg: MessageHandler {
     fileprivate static let serializationQueue = ActorLock()
 
diff --git a/Sources/SWBBuildService/Session.swift b/Sources/SWBBuildService/Session.swift
@@ -73,7 +73,7 @@ package final class Session {
             session.currentPIFTransferOperation = nil
         }
 
-        /// Continue the operation, either completing it if all data is transfered, or reporting on the remaining objects to transfer.
+        /// Continue the operation, either completing it if all data is transferred, or reporting on the remaining objects to transfer.
         func continueOperation() -> Status {
             let missingObjects = Array(loadingSession.missingObjects)
             if missingObjects.isEmpty {

Original file line number	Diff line number	Diff line change
`@@ -1095,7 +1095,7 @@ final class OperationDelegate: BuildOperationDelegate {`
`1095`	`1095`	`// We also send back a snapshot of the information on the target we have, since we are in a better position to retrieve it (rather than force the client to have an immutable cache).`
`1096`	`1096`	`//`
`1097`	`1097`	`// FIXME: Compute configurationIsDefault correctly.`
`1098`		- // FIXME (rdar://53726633): It's really not safe to be using the `target` property off of the `configuredTarget` due to the fact that this can hold old references to project model items if the PIF/build descriptions are re-used, but the project model instances are re-created. This is a targetted fix for rdar://50962080, which should be address more correctly later.
	`1098`	+ // FIXME (rdar://53726633): It's really not safe to be using the `target` property off of the `configuredTarget` due to the fact that this can hold old references to project model items if the PIF/build descriptions are re-used, but the project model instances are re-created. This is a targeted fix for rdar://50962080, which should be address more correctly later.
`1099`	`1099`	`guard let target = workspaceContext.workspace.target(for: configuredTarget.target.guid) else {`
`1100`	`1100`	`preconditionFailure("Unable to find target '\(configuredTarget.target.name)' in workspace '\(workspaceContext.workspace.name)'.")`
`1101`	`1101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ extension BuildService {`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`
`92`		`- /// Common entry point to the build serivce for in-process and out-of-process connectons.`
	`92`	`+ /// Common entry point to the build service for in-process and out-of-process connectons.`
`93`	`93`	`///`
`94`	`94`	/// Called directly from the exported C entry point `swiftbuildServiceEntryPoint` for in-process connections, or from `BuildService.main()` (after some basic file descriptor setup) for out-of-process connections.
`95`	`95`	`fileprivate static func run(inputFD: FileDescriptor, outputFD: FileDescriptor, connectionMode: ServiceHostConnectionMode, pluginsDirectory: URL?, arguments: [String], pluginLoadingFinished: () throws -> Void) async throws {`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ package final class Session {`
`73`	`73`	`session.currentPIFTransferOperation = nil`
`74`	`74`	`}`
`75`	`75`
`76`		`- /// Continue the operation, either completing it if all data is transfered, or reporting on the remaining objects to transfer.`
	`76`	`+ /// Continue the operation, either completing it if all data is transferred, or reporting on the remaining objects to transfer.`
`77`	`77`	`func continueOperation() -> Status {`
`78`	`78`	`let missingObjects = Array(loadingSession.missingObjects)`
`79`	`79`	`if missingObjects.isEmpty {`