summaryrefslogtreecommitdiff
path: root/objective-c
diff options
context:
space:
mode:
authorBernard Normier <bernard@zeroc.com>2017-06-29 16:37:59 -0400
committerBernard Normier <bernard@zeroc.com>2017-06-29 16:37:59 -0400
commitcc11eb9f2b8c724755071e8dd94f40559372edfd (patch)
treed79103bf55b93150b1e3487d7eec168a861b7dd6 /objective-c
parentAdded instructions for iOS (diff)
downloadice-cc11eb9f2b8c724755071e8dd94f40559372edfd.tar.bz2
ice-cc11eb9f2b8c724755071e8dd94f40559372edfd.tar.xz
ice-cc11eb9f2b8c724755071e8dd94f40559372edfd.zip
Fixed formatting
Diffstat (limited to 'objective-c')
-rw-r--r--objective-c/BuildInstructions.md42
1 files changed, 21 insertions, 21 deletions
diff --git a/objective-c/BuildInstructions.md b/objective-c/BuildInstructions.md
index 924a4b83e5e..1700ec611d5 100644
--- a/objective-c/BuildInstructions.md
+++ b/objective-c/BuildInstructions.md
@@ -16,33 +16,33 @@ our [supported platforms][2].
The build of Ice for Objective-C requires that you first build Ice for C++ in the
`cpp` subdirectory for the same configuration(s) and platform(s).
-Review the top-level [config/Make.rules](../config/Make.rules) in your build tree and
+Review the top-level [config/Make.rules](../config/Make.rules) in your build tree and
update the configuration if needed. The comments in the file provide more information.
Change to the Ice for Objective-C source subdirectory:
```
- $ cd objective-c
+ cd objective-c
```
Run `make` to build the Ice Objective-C libraries and test suite. Set `V=1` to get
a more detailed build output. You can build only the libraries with the `srcs`
target, or only the tests with the `tests` target. For example:
```
- $ make V=1 -j8 srcs
+ make V=1 -j8 srcs
```
### Build configurations and platforms
The Objective-C source tree supports multiple build configurations and platforms.
To see the supported configurations and platforms:
-
+```
make print V=supported-configs
make print V=supported-platforms
-
+```
To build all the supported configurations and platforms:
-
+```
make CONFIGS=all PLATFORMS=all -j8
-
-The `arc-` configurations (for [Automatic Reference Counting][3]) apply only to the
+```
+The `arc-` configurations (for [Automatic Reference Counting][3]) apply only to the
test suite; the Ice libraries don't use these configurations, and the same Ice for
Objective-C library can be used with and without ARC.
@@ -51,10 +51,10 @@ Objective-C library can be used with and without ARC.
The build system supports building Xcode SDKs for Ice. These SDKs allow you to
easily develop Ice applications with Xcode. To build Xcode SDKs, use the
`xcodesdk` configurations:
-
+```
make CONFIGS=xcodesdk -j8 srcs # Build the Objective-C mapping Xcode SDK
# for the default platform
-
+```
The Xcode SDKs are built into `ice/IceSDK`.
## Installing an Objective-C Source Build
@@ -68,36 +68,36 @@ location of the library directory with the `-L` option.
## Building the Test Suite
-`make all` or `make tests` builds the test suite for the platform(s) and
-configuration(s) you selected.
+`make all` or `make tests` builds the test suite for the platform(s) and
+configuration(s) you selected.
-However, in order to run the test suite on `iphoneos`, you need to build the
-Objective-C Controller App from Xcode:
- - Open the Objective-C Test Controller project located in the
+However, in order to run the test suite on `iphoneos`, you need to build the
+Objective-C Controller app from Xcode:
+ - Open the Objective-C Test Controller project located in the
`objective-c\test\ios\controller` directory.
- Build the `Objective-C Controller` or `Objective-C ARC Controller` app.
## Running the Test Suite
Python is required to run the test suite. After a successful source build, you
-can run the tests as shown below. If everything worked out, you should see lots
+can run the tests as shown below. If everything worked out, you should see lots
of `ok` messages. In case of a failure, the tests abort with `failed`.
### macOS
```
- $ python allTests.py # default config and default platform
- $ python allTests --config=... --platform=... # use the specified config and platform
+ python allTests.py # default config and default platform
+ python allTests --config=... --platform=... # use the specified config and platform
```
### iOS Simulator
```
- $ python allTests.py --config=xcodesdk --platform=iphonesimulator --controller-app
+ python allTests.py --config=xcodesdk --platform=iphonesimulator --controller-app
```
### iOS
- - Start the `Objective-C Controller` or `Objective-C ARC Controller` app on your iOS
+ - Start the `Objective-C Controller` or `Objective-C ARC Controller` app on your iOS
device, from Xcode.
- On your Mac:
```
- $ python allTests.py --config=xcodesdk --platform=iphoneos
+ python allTests.py --config=xcodesdk --platform=iphoneos
```
All the test clients and servers run on the iOS device, not on your Mac computer.