Skip to content

Commit d96befc

Browse files
committed
Add note about Xamarin iOS testing.
1 parent fe60486 commit d96befc

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ Dim unpackedObject = serializer.Unpack(stream)
3939
* Generating pre-compiled assembly for rapid start up.
4040
* Flexible MessagePackObject which represents MessagePack type system naturally.
4141

42+
**Note: AOT support is limited yet. Use [serializer pre-generation](https://github.com/msgpack/msgpack-cli/wiki/Xamarin-and-Unity) with `mpu -s` utility or API.**
43+
If you do not pre-generated serializers, MsgPack for CLI uses reflection in AOT environments, it is slower and it sometimes causes AOT related error (`ExecutionEngineException` for runtime JIT compilation).
44+
4245
## Documentation
4346

4447
See [wiki](https://github.com/msgpack/msgpack-cli/wiki)
@@ -95,6 +98,31 @@ Because we will not guarantee source code organization compatibilities, we might
9598
If you want to import sources, you must include just only described on MsgPack.Unity3D.csproj.
9699
If you want to use ".NET 2.0 Subset" settings, you must use just only described on MsgPack.Unity3D.CorLibOnly.csproj file, and define `CORLIB_ONLY` compiler constants.
97100

101+
### Xamarin iOS testing
102+
103+
You must create provisoning profiles in your MacOS devices.
104+
See [Xamarin documents about provisining](https://developer.xamarin.com/guides/ios/getting_started/installation/device_provisioning/free-provisioning/) for details.
105+
106+
There are bundle IDs of current iOS tests:
107+
* `org.msgpack.msgpack-cli-xamarin-ios-test`
108+
* `org.msgpack.msgpack-cli-xamarin-ios-test-packer`
109+
* `org.msgpack.msgpack-cli-xamarin-ios-test-unpacker`
110+
* `org.msgpack.msgpack-cli-xamarin-ios-test-unpacking`
111+
* `org.msgpack.msgpack-cli-xamarin-ios-test-timestamp`
112+
* `org.msgpack.msgpack-cli-xamarin-ios-test-arrayserialization`
113+
* `org.msgpack.msgpack-cli-xamarin-ios-test-mapserialization`
114+
115+
*Note that some reflection based serializer tests failed with AOT related limitation.*
116+
117+
#### Trouble shooting tips
118+
119+
See [Xamarin's official trouble shooting docs first.](https://developer.xamarin.com/guides/ios/getting_started/installation/windows/connecting-to-mac/troubleshooting/)
120+
121+
* An error occurred while running unit test project.
122+
* Rebuild the project and rerun it. Or, login your Mac again, ant retry it.
123+
* It is hard to read English.
124+
* You can read localized Xamarin docs with putting `{region}-{lang}` as the first component of URL path such as `https://developer.xamarin.com/ja-jp/guides/...`.
125+
98126
## See also
99127

100128
* GitHub Page : http://cli.msgpack.org/

0 commit comments

Comments
 (0)