You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Docs/GettingStarted.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -37,8 +37,8 @@ Build and test steps:
37
37
In order to increase the compatibility between corelibs-foundation and the native Foundation shipped with macOS, there is another Xcode project in the `swift-corelibs-foundation` repository called `DarwinCompatibilityTests.xcodeproj`. This project just runs all of the `TestFoundation` tests using native Foundation. Ideally, any new test written for corelibs-foundation should be tested against
38
38
native Foundation to validate that that test is correct. The tests can be run individually using the Test navigator in the left hand pane.
39
39
40
-
It should be noted that not all tests currently run correctly either due to differences between the two implentations, the test being used to validate some
41
-
intenal functionality of corelibs-foundation or the test (and the implementation) actually being incorrect. Overtime these test differences should be reduced as compatibility is increased.
40
+
It should be noted that not all tests currently run correctly either due to differences between the two implementations, the test being used to validate some
41
+
internal functionality of corelibs-foundation or the test (and the implementation) actually being incorrect. Overtime these test differences should be reduced as compatibility is increased.
42
42
43
43
44
44
## On Linux
@@ -58,8 +58,8 @@ The default build script does not include Foundation. To configure and build Fou
58
58
59
59
The build artifacts will be written to the subdirectory `build/Ninja-ReleaseAssert`. To use a different build directory set the `SWIFT_BUILD_ROOT` environment variable to point to a different directory to use instead of `build`.
60
60
61
-
When developing on Foundation, it is simplest to write tests to check the functionality, even if the test is not something that can be used in the final PR, e.g. it runs continously to demostrate a memory leak. Tests are added
62
-
to the appropiate file in the `TestFoundation` directory, and remember to add the test in to the `allTests` array in that file.
61
+
When developing on Foundation, it is simplest to write tests to check the functionality, even if the test is not something that can be used in the final PR, e.g. it runs continuously to demonstrate a memory leak. Tests are added
62
+
to the appropriate file in the `TestFoundation` directory, and remember to add the test in to the `allTests` array in that file.
63
63
64
64
After the complete Swift build has finished you can iterate over changes you make to Foundation using `cmake` to build `TestFoundation` and run the tests.
65
65
Note that `cmake` needs to be a relatively recent version, currently 3.15.1, and if this is not installed already
@@ -73,7 +73,7 @@ then it is built as part of the `build-script` invocation. Therefore `cmake` may
73
73
% $SWIFT_BUILD_ROOT=build $BUILD_ROOT/cmake-linux-x86_64/bin/cmake --build $BUILD_ROOT/Ninja-ReleaseAssert/foundation-linux-x86_64/ -v -- -j4 test
74
74
```
75
75
76
-
If `TestFoundation` needs to be run outside of `ctest`, perhaps to run under `lldb` or to run individual tests, then it can be run directly but an appropiate`LD_LIBRARY_PATH`
76
+
If `TestFoundation` needs to be run outside of `ctest`, perhaps to run under `lldb` or to run individual tests, then it can be run directly but an appropriate`LD_LIBRARY_PATH`
77
77
needs to be set so that `libdispatch` and `libXCTest` can be found.
78
78
79
79
```
@@ -84,7 +84,7 @@ needs to be set so that `libdispatch` and `libXCTest` can be found.
84
84
To run only one test class or a single test, the tests to run can be specified as a command argument in the form of `TestFoundation.<TestClass>{/testName}` eg to run all of the tests in `TestDate` use
85
85
`TestFoundation.TestDate`. To run just `test_BasicConstruction`, use `TestFoundation.TestDate/test_BasicConstruction`.
86
86
87
-
If the tests need to be run under `lldb`, use the following comand:
87
+
If the tests need to be run under `lldb`, use the following command:
0 commit comments