Skip to content

Commit 0cc2cb0

Browse files
authored
docs: fix a bunch of typos in SWBCore specs (#187)
1 parent 64c662c commit 0cc2cb0

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

Sources/SWBCore/Specs/CommandLineToolSpec.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public import struct Foundation.Data
1515
public import class Foundation.JSONDecoder
1616
public import SWBMacro
1717

18-
/// Describes the type and other characterstics of a single kind of input file accepted by a build tool.
18+
/// Describes the type and other characteristics of a single kind of input file accepted by a build tool.
1919
struct InputFileTypeDescriptor: Encodable, Sendable {
2020
/// Identifier of the file type — this is unbound until the build tool is used, since the particular file type any given identifier maps to can depend on the context.
2121
let identifier: String
@@ -509,7 +509,7 @@ open class CommandLineToolSpec : PropertyDomainSpec, SpecType, TaskTypeDescripti
509509
} else if let inherited = (basedOnSpec as? CommandLineToolSpec)?.outputs {
510510
self.outputs = inherited
511511
} else {
512-
// If the tool defined no outputs then force the definition of one using $(OutputPath). This correpsonds to the effective behavior of Xcode, which would implicitly create the output node when the spec asked for [output].
512+
// If the tool defined no outputs then force the definition of one using $(OutputPath). This corresponds to the effective behavior of Xcode, which would implicitly create the output node when the spec asked for [output].
513513
//
514514
// FIXME: Force the specs to define this, instead of synthesizing it: <rdar://problem/24544779> [Swift Build] Stop synthesizing Outputs for generic command line tools
515515
self.outputs = [parser.delegate.internalMacroNamespace.parseString("$(OutputPath)")]
@@ -1417,7 +1417,7 @@ open class GenericCommandLineToolSpec : CommandLineToolSpec, @unchecked Sendable
14171417
/// A general-purpose output parser for scraping traditional POSIX-style diagnostics. Output is passed through to the delegate as it is received, while diagnostic parsing is done line-by-line as each newline is encountered.
14181418
open class GenericOutputParser : TaskOutputParser {
14191419

1420-
/// The delegate that's informed about ouput and diagnostics.
1420+
/// The delegate that's informed about output and diagnostics.
14211421
public let delegate: any TaskOutputParserDelegate
14221422

14231423
/// Workspace context associated with the output parser.
@@ -1470,7 +1470,7 @@ open class GenericOutputParser : TaskOutputParser {
14701470
// Following that, there must be a diagnostic kind keyword or a basename
14711471
// alias, and then a diagnostic.
14721472
//
1473-
// We also retrict the leading indicator to not have any quote characters,
1473+
// We also restrict the leading indicator to not have any quote characters,
14741474
// which helps filter out anything which looks like a diagnostic but is
14751475
// appearing within a quoted string.
14761476
self.diagnosticRegex = try! RegEx(pattern: "^([^'\"]+: +|[ \\t\\f\\p{Z}]*)(error|warning|note|notice|fixit|\(toolnameSubregex)): (.*)$")

Sources/SWBCore/Specs/CoreBuildSystem.xcspec

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1757,7 +1757,7 @@ When `GENERATE_INFOPLIST_FILE` is enabled, sets the value of the [CFBundleIdenti
17571757
* When set to Automatic, this target's immediate dependencies which build dynamic libraries or frameworks and are in its Link Binaries With Libraries will automatically be built as mergeable libraries and merged into this target's binary during release builds, or reexported during debug builds.
17581758
* When set to Manual, only immediate dependencies which have Build Mergeable Library explicitly enabled will be merged or reexported.
17591759

1760-
For more information on mergable libraries, see [Configuring your project to use mergeable libraries](https://developer.apple.com/documentation/xcode/configuring-your-project-to-use-mergeable-libraries).";
1760+
For more information on mergeable libraries, see [Configuring your project to use mergeable libraries](https://developer.apple.com/documentation/xcode/configuring-your-project-to-use-mergeable-libraries).";
17611761
},
17621762
{
17631763
Name = "AUTOMATICALLY_MERGE_DEPENDENCIES";
@@ -1777,7 +1777,7 @@ For more information on mergable libraries, see [Configuring your project to use
17771777
DisplayName = "Build Mergeable Library";
17781778
Description = "For dynamic libraries and frameworks, links this target's binary as a mergeable library which can be merged into the product of a target which depends on it if that target is configured to do so. This target will be linked as a mergeable library in release builds so it can be merged, but will instead be linked as a normal dynamic library to be reexported in debug builds. For other binary types, this setting has no effect.
17791779

1780-
For more information on mergable libraries, see [Configuring your project to use mergeable libraries](https://developer.apple.com/documentation/xcode/configuring-your-project-to-use-mergeable-libraries).";
1780+
For more information on mergeable libraries, see [Configuring your project to use mergeable libraries](https://developer.apple.com/documentation/xcode/configuring-your-project-to-use-mergeable-libraries).";
17811781
},
17821782
{
17831783
Name = "MAKE_MERGEABLE";
@@ -1925,7 +1925,7 @@ For more information on mergable libraries, see [Configuring your project to use
19251925
);
19261926
DefaultValue = "compiler-default";
19271927
DisplayName = "Text-Based InstallAPI Language Dialect";
1928-
Description = "Selects the langauge dialect when building `Text-Based InstallAPI`.";
1928+
Description = "Selects the language dialect when building `Text-Based InstallAPI`.";
19291929
ConditionFlavors = (
19301930
arch,
19311931
sdk,

Sources/SWBCore/Specs/ProductTypes.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ public final class XCTestBundleProductTypeSpec : BundleProductTypeSpec, @uncheck
661661
table.push(BuiltinMacros.XCTRUNNER_PRODUCT_NAME, table.namespace.parseString("$(PRODUCT_NAME)-Runner.app"))
662662

663663
// Define TARGET_BUILD_SUBPATH so the target builds to $(TARGET_BUILD_DIR)/$(TARGET_BUILD_SUBPATH) (or slightly different for deployment location builds).
664-
// <rdar://problem/18902931> Should PBXXCTestBundleProductType override BUILT_PRODUCTS_DIR when it overrides TARGET_BULD_DIR?
664+
// <rdar://problem/18902931> Should PBXXCTestBundleProductType override BUILT_PRODUCTS_DIR when it overrides TARGET_BUILD_DIR?
665665
table.push(BuiltinMacros.TARGET_BUILD_SUBPATH, table.namespace.parseString("/$(XCTRUNNER_PRODUCT_NAME)$(_WRAPPER_CONTENTS_DIR)/PlugIns"))
666666
table.push(BuiltinMacros.DWARF_DSYM_FOLDER_PATH, table.namespace.parseString("$(TARGET_BUILD_DIR)")) // Do we really want dSYMs to go inside of the host app's PlugIns dir?
667667

@@ -706,7 +706,7 @@ public final class XCTestBundleProductTypeSpec : BundleProductTypeSpec, @uncheck
706706
}
707707

708708
// Define TARGET_BUILD_SUBPATH so the target builds to $(TARGET_BUILD_DIR)/$(TARGET_BUILD_SUBPATH) (or slightly different for deployment location builds).
709-
// <rdar://problem/18902931> Should PBXXCTestBundleProductType override BUILT_PRODUCTS_DIR when it overrides TARGET_BULD_DIR?
709+
// <rdar://problem/18902931> Should PBXXCTestBundleProductType override BUILT_PRODUCTS_DIR when it overrides TARGET_BUILD_DIR?
710710
table.push(BuiltinMacros.TARGET_BUILD_SUBPATH, table.namespace.parseLiteralString("/\(targetBuildSubpath)"))
711711
table.push(BuiltinMacros.DWARF_DSYM_FOLDER_PATH, table.namespace.parseString("$(TARGET_BUILD_DIR)"))
712712

Sources/SWBCore/Specs/PropertyDomainSpec.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ private let buildOptionTypes: [String: any BuildOptionType] = [
223223
/// Expand to the literal dynamic value, unmodified.
224224
case literal
225225

226-
/// Expand into the given arguments, after macro expression evaluation (as appropiate for the macro type). The special macro '$(value)' can be used to refer to the dynamic value of the option.
226+
/// Expand into the given arguments, after macro expression evaluation (as appropriate for the macro type). The special macro '$(value)' can be used to refer to the dynamic value of the option.
227227
case args(MacroStringListExpression)
228228

229229
/// Expand to the given flag.

Sources/SWBCore/Specs/SpecRegistry.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public protocol SpecType: AnyObject {
4444
/// The name of the spec subregistry to associate with this type.
4545
static var subregistryName: String { get }
4646

47-
/// The default class type to instantiate as, if not overriden.
47+
/// The default class type to instantiate as, if not overridden.
4848
///
4949
/// By default, this will be the SpecType itself, however this can be used to force specs which do not override 'Class' to be instantiated as a separate type (which would generally be a subclass of the actual SpecType). This is useful when specs without a custom 'Class' support a different set of keys than those that do.
5050
static var defaultClassType: (any SpecType.Type)? { get }
@@ -657,7 +657,7 @@ public final class SpecRegistry {
657657

658658
// Load the localized strings, if available.
659659
//
660-
// We currently hard code a local search, asuming the xcspec file is adjacent to the `strings` file or the containing `lproj`.
660+
// We currently hard code a local search, assuming the xcspec file is adjacent to the `strings` file or the containing `lproj`.
661661
func loadLocalizedStrings(_ path: Path) -> [String: String]? {
662662
if let data = try? PropertyList.fromPath(path, fs: localFS) {
663663
// If we found a property list, it should be a map of strings.
@@ -909,7 +909,7 @@ public final class SpecRegistry {
909909
print(error)
910910
}
911911

912-
// Find places where a proxy illegally depends on a spec overriden in a subdomain.
912+
// Find places where a proxy illegally depends on a spec overridden in a subdomain.
913913
//
914914
// Essentially, if spec in a generic domain (foo:default) is based on an unspecified specification (bar), which is in a more specific domain 'device', then the semantics we want are that a search for 'foo:device' will return 'foo:device basedOn bar:device'. These are unfortunate semantics to implement dynamically (we want each proxy to resolve to one spec), so instead we clone any proxies that might need to satisfy this.
915915

Sources/SWBCore/Specs/Specs.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ open class Spec: @unchecked Sendable {
5555
return result
5656
}
5757

58-
/// The spec proxy informaton.
58+
/// The spec proxy information.
5959
@_spi(Testing) public let proxyPath: Path
6060
@_spi(Testing) public let proxyDomain: String
6161
@_spi(Testing) public let proxyIdentifier: String

0 commit comments

Comments
 (0)