Skip to content

Commit db38cc7

Browse files
Update Contributing.md fix error Updating to Latest Package Versions
1 parent 1748933 commit db38cc7

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

Documentation/Contributing.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Swift Package Manager: Quick Start
2-
Swift Package Manager (SwiftPM) is a tool for building, testing and managing Swift project dependencies.
3-
In order to use it you will need Swift 3.0 or greater.
4-
SwiftPM is also included in Xcode 8.0 and above.
5-
For usage getting started: [https://swift.org/getting-started/#using-the-package-manager](https://swift.org/getting-started/#using-the-package-manager)
2+
Swift Package Manager (SwiftPM) is a tool for building, testing and managing Swift project dependencies.
3+
In order to use it you will need Swift 3.0 or greater.
4+
SwiftPM is also included in Xcode 8.0 and above.
5+
For usage getting started: [https://swift.org/getting-started/#using-the-package-manager](https://swift.org/getting-started/#using-the-package-manager)
66
For overview and examples: [https://swift.org/package-manager](https://swift.org/package-manager/)
77

88
## Code Contributions
9-
Everyone is welcome to contribute to SwiftPM, submitting fixes, enhancement etc.
9+
Everyone is welcome to contribute to SwiftPM, submitting fixes, enhancement etc.
1010
Find out how previous coding decisions for SwiftPM evolution have been made: https://github.com/apple/swift-package-manager/blob/main/Documentation/Internals/PackageManagerCommunityProposal.md
1111

1212
### Requirements
13-
You have multiple ways to setup your development environment, here we will focus on 2:
13+
You have multiple ways to setup your development environment, here we will focus on 2:
1414
A) *[Using Xcode](#using-xcode)* or B) [Using *the standalone Swift toolchain*](#using-standalone).
1515

1616
<a id="using-xcode">*A) _Use Xcode to setup what you need_*.</a>
@@ -56,7 +56,7 @@ git clone https://github.com/apple/swift-package-manager.git
5656
$> cd swift-package-manager
5757
$> swift build
5858
```
59-
If the build process ends with exit code 0, the build is successful (we have an Enhancement Radar to implement a message for successful build and a short output on where the generated binaries are: rdar://69970428).
59+
If the build process ends with exit code 0, the build is successful (we have an Enhancement Radar to implement a message for successful build and a short output on where the generated binaries are: rdar://69970428).
6060
After a successful build (currently), you should see something like this:
6161
```
6262
[476/476] Linking swift-package
@@ -72,7 +72,7 @@ debug.yaml
7272
manifest.db
7373
workspace-state.json
7474
```
75-
Binaries (in the example above) are in `x86_64-apple-macosx/`
75+
Binaries (in the example above) are in `x86_64-apple-macosx/`.
7676
If you need to build the generated binaries, run `swift-build` in inside `.build/`:
7777
```
7878
./.build/x86_64-apple-macosx/debug/swift-build
@@ -96,8 +96,8 @@ If you are contributing using macOS, the best option is to use Xcode to build an
9696
^
9797
( )
9898
```
99-
Do not worry, since those are known warnings that will be addressed at some point.
100-
Warnings differ depending on the platform and they can be seen from time to time due the amount of contributions.
99+
Do not worry, since those are known warnings that will be addressed at some point.
100+
Warnings differ depending on the platform and they can be seen from time to time due the amount of contributions.
101101
Our goal is to constantly monitor warnings and work on fix them (even if they are not affecting a successful implementation).
102102
* If during `swift build` you encounter this error:
103103
```
@@ -110,9 +110,21 @@ Make sure you are using SwiftPM 5.3
110110
$> swift package --version
111111
Swift Package Manager - Swift 5.3.0
112112
```
113+
* If during `swift build` you encounter this error:
114+
```
115+
/../swift-package-manager/Sources/PackageLoading/Target+PkgConfig.swift:84:36: error: type 'PkgConfigError' has no member 'prohibitedFlags'
116+
error = PkgConfigError.prohibitedFlags(filtered.unallowed.joined(separator: ", "))
117+
~~~~~~~~~~~~~~ ^~~~~~~~~~~~~~~
118+
```
119+
Make sure to update your TSC (Tools Support Core):
120+
```
121+
swift package update
122+
```
123+
Alternatively, if you are using Xcode, you can update to the latest version of all packages:
124+
**Xcode App** > *File* > *Swift Packages* > *Update to Latest Package Versions*
113125

114126
### Find your way to contribute
115-
Report a bug guide: https://github.com/apple/swift-package-manager/blob/main/Documentation/Resources.md#reporting-a-good-swiftpm-bug.
127+
Report a bug guide: https://github.com/apple/swift-package-manager/blob/main/Documentation/Resources.md#reporting-a-good-swiftpm-bug.
116128
JIRA Bug Tracker (a place where you can open bugs, enhancements to start to contribute): [https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22](https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22).
117129

118130
### Commits / PRs

0 commit comments

Comments
 (0)