Skip to content

Commit b08692f

Browse files
authored
Fix typos in comments and symbols naming (#7318)
1 parent 5b1fe44 commit b08692f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+79
-79
lines changed

Documentation/Design/PackageManagerCommunityProposal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Swift Package Manager Community Proposal
22

3-
> **PLEASE NOTE** This document represents the initial proposal for Swift Package Manger, and is provided for historical purposes only. It does not represent the current state or future direction of the project. For current documentation, see the main Swift Package Manager [documentation](../README.md).
3+
> **PLEASE NOTE** This document represents the initial proposal for Swift Package Manager, and is provided for historical purposes only. It does not represent the current state or future direction of the project. For current documentation, see the main Swift Package Manager [documentation](../README.md).
44
55
---
66

Documentation/Design/SwiftBasedManifestFormat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Swift-based Manifest Format
22

3-
> **PLEASE NOTE** This document represents the initial proposal for Swift Package Manger, and is provided for historical purposes only. It does not represent the current state or future direction of the project. For current documentation, see the main Swift Package Manager [documentation](../README.md).
3+
> **PLEASE NOTE** This document represents the initial proposal for Swift Package Manager, and is provided for historical purposes only. It does not represent the current state or future direction of the project. For current documentation, see the main Swift Package Manager [documentation](../README.md).
44
55
## Purpose
66

@@ -122,7 +122,7 @@ It is important to note that even when using this feature, package manifest stil
122122

123123
The package definition format being written in Swift is problematic for tools that wish to perform automatic updates to the file (for example, in response to a user action, or to bind to a user interface), or for situations where dealing with executable code is problematic.
124124

125-
To that end, the declarative package specification portion of the file is "Swift" in the same sense that "JSON is Javascript". The syntax itself is valid, executable, Swift but the tools that process it will only accept a restricted, declarative, subset of Swift which can be statically evaluated, and which can be unambiguously, automatically rewritten by editing tools. We do not intend to define a "standard" syntax for "Swift Object Notation", but we intend to accept a natural restriction of the language which only accepts literal expressions. We do intend to allow the restricted subset to take full advantage of Swift's rich type inference and literal convertable design to allow for a succinct, readable, and yet expressive syntax.
125+
To that end, the declarative package specification portion of the file is "Swift" in the same sense that "JSON is Javascript". The syntax itself is valid, executable, Swift but the tools that process it will only accept a restricted, declarative, subset of Swift which can be statically evaluated, and which can be unambiguously, automatically rewritten by editing tools. We do not intend to define a "standard" syntax for "Swift Object Notation", but we intend to accept a natural restriction of the language which only accepts literal expressions. We do intend to allow the restricted subset to take full advantage of Swift's rich type inference and literal convertible design to allow for a succinct, readable, and yet expressive syntax.
126126

127127
The customization section above will *not* be written in this syntax. Instead, the customization section will be clearly demarcated in the file. The leading file section up to the first '// MARK:' will be processed as part of the restricted declarative specification. All subsequent code **must be** honored by tools which only need to consume the output of the specification, and **should be** displayed by tools which present an editor view of the manifest, but **should not** be automatically modified. The semantics of the APIs will be specifically designed to accommodate the expected use case of editor support for the primary data with custom project-specific logic for special cases.
128128

Documentation/ModuleAliasing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ If more aliases need to be defined, they can be added with a comma delimiter, pe
121121

122122
## Override Module Aliases
123123

124-
If module alias values defined upstream are conflicting downstream, they can be overriden by chaining; add an entry to the `moduleAliases` parameter downstream using the conflicting alias value as a key and provide a unique value.
124+
If module alias values defined upstream are conflicting downstream, they can be overridden by chaining; add an entry to the `moduleAliases` parameter downstream using the conflicting alias value as a key and provide a unique value.
125125

126126
To illustrate, the `swift-draw` and `swift-game` packages are modified to have the following dependencies and module aliases.
127127

@@ -190,7 +190,7 @@ To override it, the `App` manifest can define its own module aliases per below.
190190
])
191191
]
192192
```
193-
The `Utils` module from package `a-utils` will be renamed as `DrawUtils`, and `Utils` from package `c-utils` will be renamed as `GameUtils`. Each overriden alias will be applied to all of the targets that depend on each module.
193+
The `Utils` module from package `a-utils` will be renamed as `DrawUtils`, and `Utils` from package `c-utils` will be renamed as `GameUtils`. Each overridden alias will be applied to all of the targets that depend on each module.
194194

195195
## Requirements
196196

Documentation/PackageRegistry/PackageRegistryUsage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ any package identifier (e.g., `mona.LinkedList`).
158158
One can control if/how SwiftPM should use registry in conjunction with
159159
source control dependencies by setting one of these flags:
160160
- `--disable-scm-to-registry-transformation` (default): SwiftPM will not transform source control dependency to registry dependency. Source control dependency will be downloaded from its corresponding URL, while registry dependency will be resolved and downloaded using the configured registry (if any).
161-
- `--use-registry-identity-for-scm`: SwiftPM will look up source control dependencies in the registry and use their registry identity whenever possible to help deduplicate packages across the two origins. In other words, suppose `mona.LinkedList` is the package identifer for `https://github.com/mona/LinkedList`, then SwiftPM will treat both references in the dependency graph as the same package.
161+
- `--use-registry-identity-for-scm`: SwiftPM will look up source control dependencies in the registry and use their registry identity whenever possible to help deduplicate packages across the two origins. In other words, suppose `mona.LinkedList` is the package identifier for `https://github.com/mona/LinkedList`, then SwiftPM will treat both references in the dependency graph as the same package.
162162
- `--replace-scm-with-registry`: SwiftPM will look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible. In other words, SwiftPM will attempt to download a source control dependency from the registry first, and fall back to cloning the source repository iff the dependency is not found in the registry.
163163

164164
## Dependency Download From Registry
@@ -183,7 +183,7 @@ or previous value, SwiftPM will fail the build. This can be
183183
tuned down from error to warning by setting the build option
184184
`--resolver-fingerprint-checking` to `warn` (default is `strict`).
185185

186-
Checkum TOFU is also done for manifests downloaded from registry.
186+
Checksum TOFU is also done for manifests downloaded from registry.
187187

188188
### Validating signed packages
189189

@@ -456,7 +456,7 @@ $ swift package-registry set --scope foo https://local.example.com
456456
$ swift package-registry set --scope foo --global https://global.example.com
457457
```
458458
459-
To remove a registry assignement, use the `swift package-registry unset` subcommand.
459+
To remove a registry assignment, use the `swift package-registry unset` subcommand.
460460
461461
### Security configuration
462462

Documentation/PackageSecurity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ the build option `--resolver-fingerprint-checking` to `warn` (default is `strict
3838

3939
Note that in case of registry packages, a package version's fingerprint
4040
must be consistent across registries or else there will be a TOFU failure.
41-
As an example, suppose a package version was originially downloaded from
41+
As an example, suppose a package version was originally downloaded from
4242
registry A and the source archive checksum was saved as the fingerprint. Later
4343
the package version is downloaded again but from registry B and has a different
4444
fingerprint. This would trigger a TOFU failure since the fingerprint should

Documentation/ReleaseNotes/5.4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ All [Unicode line terminators](https://www.unicode.org/reports/tr14/) are now re
2727

2828
Swift Package Manager now caches package dependency repositories on a per-user basis, which reduces the amount of network traffic and increases performance of dependency resolution for subsequent uses of the same package.
2929

30-
The default location of the cache differs dependening on the platform, but can be controlled using the new `--cache-path` option. SwiftPM also creates a symbolic link at `~/.swiftpm` referencing the default cache location.
30+
The default location of the cache differs depending on the platform, but can be controlled using the new `--cache-path` option. SwiftPM also creates a symbolic link at `~/.swiftpm` referencing the default cache location.
3131

3232
Compiled package manifests are also now cached on a per-user basis. This can be overridden using the new `--manifest-cache` option.

Documentation/ReleaseNotes/5.6.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Dependency requirement enum calling convention is deprecated in favour of labele
2626

2727
### Other Improvements
2828

29-
Location of configuration files (including mirror file) have changed to accomodate new features that require more robust configuration directories structure, such as SE-0292:
29+
Location of configuration files (including mirror file) have changed to accommodate new features that require more robust configuration directories structure, such as SE-0292:
3030

3131
* `<project>/.swiftpm/config` (mirrors file) was moved to `<project>/.swiftpm/configuration/mirrors.json`. SwiftPM 5.6 will automatically copy the file from the old location to the new one and emit a warning to prompt the user to delete the file from the old location.
3232
* `~/.swiftpm/config/collections.json` (collections file) was moved to `~/.swiftpm/configuration/collections.json`. SwiftPM 5.6 will automatically copy the file from the old location to the new one and emit a warning to prompt the user to delete the file from the old location.
3333

34-
To increase the security of packages, SwiftPM performs trust on first use (TOFU) validation. The fingerprint of a package is now being recorded when the package is first downloaded from a Git repository or package registry. Subsequent downloads must have fingerpints matching previous recorded values, otherwise it would result in build warnings or failures depending on settings.
34+
To increase the security of packages, SwiftPM performs trust on first use (TOFU) validation. The fingerprint of a package is now being recorded when the package is first downloaded from a Git repository or package registry. Subsequent downloads must have fingerprints matching previous recorded values, otherwise it would result in build warnings or failures depending on settings.
3535

3636
Introduce a second version of `Package.resolved` file format which more accurately captures package identity.

Documentation/ReleaseNotes/5.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In packages using tools version 5.8 or later, `Foundation` is no longer implicit
1212

1313
SwiftPM now supports token authentication when interacting with a package registry. The `swift package-registry` command has two new subcommands `login` and `logout` as defined in [SE-0378](https://github.com/apple/swift-evolution/blob/main/proposals/0378-package-registry-auth.md) for adding/removing registry credentials.
1414

15-
## Other improvments
15+
## Other improvements
1616

1717
Improved handling of offline behavior when a compatible cached version of a dependency exists on disk in either the per-package or shared cache. SwiftPM will check for network availability status to determine if it should attempt to update a checked version of a dependency, and when offline will use the cached version without an update.
1818

Documentation/Usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ let package = Package(
187187
name: "example",
188188
targets: [
189189
// systemLibrary is a special type of build target that wraps a system library
190-
// in a target that other targets can require as their depencency.
190+
// in a target that other targets can require as their dependency.
191191
.systemLibrary(
192192
name: "Clibgit",
193193
pkgConfig: "libgit2",
@@ -266,7 +266,7 @@ let package = Package(
266266
),
267267

268268
// systemLibrary is a special type of build target that wraps a system library
269-
// in a target that other targets can require as their depencency.
269+
// in a target that other targets can require as their dependency.
270270
.systemLibrary(
271271
name: "Clibgit",
272272
pkgConfig: "libgit2",
@@ -579,7 +579,7 @@ You can end editing a package using `unedit` command:
579579
This will remove the edited dependency from `Packages/` and put the originally
580580
resolved version back.
581581

582-
This command fails if there are uncommited changes or changes which are not
582+
This command fails if there are uncommitted changes or changes which are not
583583
pushed to the remote repository. If you want to discard these changes and
584584
unedit, you can use the `--force` option:
585585

Fixtures/Miscellaneous/CXX17CompilerCrash/v5_7/include/user_objects.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class mjCError {
8989
// alternative specifications of frame orientation
9090
class mjCAlternative {
9191
public:
92-
mjCAlternative(); // constuctor
92+
mjCAlternative(); // constructor
9393
const char* Set(double* quat, double* inertia, // set frame quat and diag. inertia
9494
bool degree, // angle format: degree/radian
9595
const char* sequence); // euler sequence format: "xyz"

0 commit comments

Comments
 (0)