diff options
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | cpp/README.md | 23 | ||||
| -rw-r--r-- | csharp/README.md | 22 | ||||
| -rw-r--r-- | doxygen/mainpage.md | 5 | ||||
| -rw-r--r-- | java-compat/README.md | 11 | ||||
| -rw-r--r-- | java/README.md | 21 | ||||
| -rw-r--r-- | js/README.md | 7 | ||||
| -rw-r--r-- | objective-c/README.md | 2 | ||||
| -rw-r--r-- | php/README.md | 3 | ||||
| -rw-r--r-- | ruby/README.md | 16 | ||||
| -rw-r--r-- | swift/README.md | 2 |
11 files changed, 49 insertions, 64 deletions
diff --git a/README.md b/README.md index cf44f227655..d71b8e85676 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ Ice supports the following programming languages: - PHP - Python - Ruby +- Swift - TypeScript ## Platforms diff --git a/cpp/README.md b/cpp/README.md index b0cc6b2c3af..bbe293bbea4 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -262,6 +262,7 @@ environment variables: Open the Visual Studio solution that corresponds to the Visual Studio version you are using. + - For Visual Studio 2019 use [msbuild/ice.v142.sln](./msbuild/ice.v142.sln) - For Visual Studio 2017 use [msbuild/ice.v141.sln](./msbuild/ice.v141.sln) - For Visual Studio 2015 use [msbuild/ice.v140.sln](./msbuild/ice.v140.sln) - For Visual Studio 2013 use [msbuild/ice.v120.sln](./msbuild/ice.v120.sln) @@ -275,24 +276,24 @@ Using the configuration manager choose the platform and configuration you want t The solution provide a project for each Ice component and each component can be built separatelly. When you build a component its dependencies are built automatically. -For Visual Studio 2017 and Visual Studio 2015, the solutions organize the projects in two -solution folders, C++11 and C++98, which correspond to the C++11 and C++98 mappings. If you -want to build all the C++11 mapping components, build the C++11 solution folder; -likewise if you want to build all the C++98 mapping components, build the C++98 -solution folder. +For Visual Studio 2019, Visual Studio 2017 and Visual Studio 2015, the solutions organize +the projects in two solution folders, C++11 and C++98, which correspond to the C++11 and +C++98 mappings. If you want to build all the C++11 mapping components, build the C++11 +solution folder; likewise if you want to build all the C++98 mapping components, build +the C++98 solution folder. For Visual Studio 2013 and Visual Studio 2010. there is no separate solution folder because only the C++98 mapping is supported with these compilers. The test suite is built using separate Visual Studio solutions: - - Ice Test Suite for Visual Studio 2017, Visual Studio 2015 and Visual Studio 2013 [msbuild/ice.test.sln](./msbuild/ice.test.sln) + - Ice Test Suite for Visual Studio 2019, Visual Studio 2017, Visual Studio 2015 and Visual Studio 2013 [msbuild/ice.test.sln](./msbuild/ice.test.sln) - Ice Test Suite for Visual Studio 2010 [msbuild/ice.test.v100.sln](./msbuild/ice.test.v100.sln) - - Ice OpenSSL Test Suite for Visual Studio 2017, Visual Studio 2015 and Visual Studio 2013 [msbuild/ice.openssl.test.sln](./msbuild/ice.openssl.test.sln) + - Ice OpenSSL Test Suite for Visual Studio 2019, Visual Studio 2017, Visual Studio 2015 and Visual Studio 2013 [msbuild/ice.openssl.test.sln](./msbuild/ice.openssl.test.sln) The solution provides a separate project for each test component, the `Cpp11-Release` and `Cpp11-Debug` build configurations are setup to use the C++11 mapping in release and debug mode respectively, and are only supported -with Visual Studio 2017 and Visual Studio 2015. The `Release` and `Debug` build configurations are setup to +with Visual Studio 2019, Visual Studio 2017 and Visual Studio 2015. The `Release` and `Debug` build configurations are setup to use the C++98 mapping in release and debug mode respectively. The building of the test uses by default the local source build, and you must have built the Ice @@ -396,8 +397,8 @@ msbuild msbuild\ice.proj /t:NuGetPack /p:BuildAllConfigurations=yes ``` This creates `zeroc.ice.v100\zeroc.ice.v100.nupkg`, -`zeroc.ice.v120\zeroc.ice.v120.nupkg`, `zeroc.ice.v140\zeroc.ice.v140.nupkg` or -`zeroc.ice.v141\zeroc.ice.v141.nupkg` +`zeroc.ice.v120\zeroc.ice.v120.nupkg`, `zeroc.ice.v140\zeroc.ice.v140.nupkg`, +`zeroc.ice.v141\zeroc.ice.v141.nupkg` or `zeroc.ice.v142\zeroc.ice.v142.nupkg` depending on the compiler you are using. To create UWP NuGet packages, use the `UWPNuGetPack` target instead: @@ -427,7 +428,7 @@ To clean the build for all the supported configurations and platforms, run Running `make distclean` will also clean the build for all the configurations and platforms. In addition, it will also remove the generated files created by -the Slice translators. +the Slice compilers. ## Running the Test Suite diff --git a/csharp/README.md b/csharp/README.md index 73ed6523d97..71cbe6a758c 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -27,7 +27,7 @@ A source build of Ice for .NET on Windows produces two sets of assemblies: In order to build Ice for .NET from source, you need all of the following: - a [supported version][3] of Visual Studio - - the [.NET Core 2.1 SDK][4], if you use Visual Studio 2017 + - the [.NET Core 2.1 SDK][4], if you use Visual Studio 2017 or Visual Studio 2019 > Note: Visual Studio 2017 version 15.3.0 or higher is required for .NET Core > builds. @@ -74,17 +74,17 @@ implement .NET Standard 2.0. You can add Strong Naming signatures to the Ice assemblies by setting the following environment variables before building these assemblies: - - PUBLIC_KEYFILE Identity public key used to delay sign the assembly - - KEYFILE Identity full key pair used to sign the assembly + - `PUBLIC_KEYFILE` Identity public key used to delay sign the assembly + - `KEYFILE` Identity full key pair used to sign the assembly -If only PUBLIC_KEYFILE is set, the assemblies are delay-signed during the build +If only `PUBLIC_KEYFILE` is set, the assemblies are delay-signed during the build and you must re-sign the assemblies later with the full identity key pair. -If only KEYFILE is set, the assemblies are fully signed during the build using +If only `KEYFILE` is set, the assemblies are fully signed during the build using KEYFILE. -If both PUBLIC_KEYFILE and KEYFILE are set, assemblies are delay-signed during -the build using PUBLIC_KEYFILE and re-signed after the build using KEYFILE. +If both `PUBLIC_KEYFILE` and `KEYFILE` are set, assemblies are delay-signed during +the build using `PUBLIC_KEYFILE` and re-signed after the build using `KEYFILE`. This can be used for generating [Enhanced Strong Naming][5] signatures. *Strong Name Signatures can be generated only from Windows builds.* @@ -93,8 +93,8 @@ This can be used for generating [Enhanced Strong Naming][5] signatures. You can sign the Ice binaries with Authenticode by setting the following environment variables before building these assemblies: - - SIGN_CERTIFICATE to your Authenticode certificate - - SIGN_PASSWORD to the certificate password + - `SIGN_CERTIFICATE` to your Authenticode certificate + - `SIGN_PASSWORD` to the certificate password *Authenticode can be generated only from Windows builds.* @@ -201,14 +201,14 @@ application. #### Windows Build Requirements -* Visual Studio 2017 with following workloads: +* Visual Studio 2017 or Visual Studio 2019 with following workloads: * Universal Windows Platform development * Mobile development with .NET * .NET Core cross-platform development #### Building the Android test controller -Open a Visual Studio 2017 command prompt: +Open a Visual Studio 2017 or Visual Studio 2019 command prompt: ``` MSBuild msbuild\ice.proj /t:AndroidXamarinBuild diff --git a/doxygen/mainpage.md b/doxygen/mainpage.md index 3d910ff0264..bdde227f716 100644 --- a/doxygen/mainpage.md +++ b/doxygen/mainpage.md @@ -2,9 +2,8 @@ This Slice API reference was generated from the Slice files in the [zeroc-ice/ice GitHub repository](https://github.com/zeroc-ice/ice/tree/3.7/slice) -using ZeroC's [fork of Doxygen](https://github.com/zeroc-ice/doxygen) that includes -Slice support. We provide a [tag file](../slice.tag) if you would like to include -links to this documentation in your own Doxygen projects. +using [Doxygen](http://www.doxygen.nl/). We provide a [tag file](../slice.tag) if you +would like to include links to this documentation in your own Doxygen projects. The [language mapping chapters](https://doc.zeroc.com/ice/3.7/language-mappings) in the [Ice Manual](https://doc.zeroc.com/ice/3.7/introduction) describe how Slice diff --git a/java-compat/README.md b/java-compat/README.md index 9f308750844..1dd37675b0d 100644 --- a/java-compat/README.md +++ b/java-compat/README.md @@ -175,9 +175,8 @@ for the Ice test suite controller. Building any Ice application for Android requires Android Studio and the Android SDK build tools. We tested with the following components: -- Android Studio 3.2.1 -- Android SDK 21 -- Android Build Tools 27.0.1 +- Android Studio 3.5 +- Android SDK 29 Ice requires at minimum API level 21: @@ -187,12 +186,6 @@ If you want to target a later version of the Android API level for the test suite, edit `test/android/controller/gradle.properties` and change the following variables: -``` -ice_compileSdkVersion -ice_minSdkVersion -ice_targetSdkVersion -``` - *NOTE: Do not use Android Studio to modify the project's settings.* ### Building the Android Test Controller diff --git a/java/README.md b/java/README.md index deb503f0d0f..c67a4b30b5b 100644 --- a/java/README.md +++ b/java/README.md @@ -97,7 +97,7 @@ GUI tool. The Maven package id for the ProGuard package is as follows: ``` -groupId='net.sf.proguard', artifactId='proguard-gradle', version='6.0' +groupId='net.sf.proguard', artifactId='proguard-gradle', version='6.1.1' ``` ### Java Application Bundler @@ -108,7 +108,7 @@ bundle for the IceGrid GUI tool. The Maven package id for the application bundler package is as follows: ``` -groupId=com.panayotis, version=1.0.2, artifactId=appbundler +groupId=com.panayotis, version=1.1.0, artifactId=appbundler ``` ## Building Ice for Java @@ -219,26 +219,13 @@ the Ice test suite controller. Building any Ice application for Android requires Android Studio and the Android SDK build tools. We tested with the following components: -- Android Studio 3.2.1 -- Android SDK 24 -- Android Build Tools 27.0.1 +- Android Studio 3.5 +- Android SDK 29 Using Ice's Java mapping with Java 8 requires at minimum API level 24: - Android 7 (API24) -If you want to target a later version of the Android API level for the test -suite, edit `test/android/controller/gradle.properties` and change the -following variables: - -``` -ice_compileSdkVersion -ice_minSdkVersion -ice_targetSdkVersion -``` - -*NOTE: Do not use Android Studio to modify the project's settings.* - ### Building the Android Test Controller You must first build Ice for Java refer to [Building Ice for Java](#building-ice-for-java-1) diff --git a/js/README.md b/js/README.md index a98efb32a44..9921f7875cb 100644 --- a/js/README.md +++ b/js/README.md @@ -62,8 +62,9 @@ subdirectory, including compressed and minified versions. For older browsers that do not support all of the required ECMAScript 6 features used by Ice for JavaScript, we provide pre-compiled versions of the libraries using the [Babel][2] JavaScript compiler. These libraries -depend on the babel polyfill run time and are available in the `lib/es5` -subdirectory with the same names as the main libraries. +depend on the `core-js`[3] and `regenerator-runtime`[4] packages +and are available in the `lib/es5` subdirectory with the same names as +the main libraries. ## Running the JavaScript Tests @@ -200,3 +201,5 @@ library files located in the `lib` directory to your web server. [1]: https://zeroc.com/distributions/ice [2]: https://babeljs.io +[3]: https://www.npmjs.com/package/core-js +[4]: https://www.npmjs.com/package/regenerator-runtime diff --git a/objective-c/README.md b/objective-c/README.md index 956b96b332b..52f7bf7cdd4 100644 --- a/objective-c/README.md +++ b/objective-c/README.md @@ -104,7 +104,7 @@ To clean the build for all the supported configurations and platforms, run Running `make distclean` will also clean the build for all the configurations and platforms. In addition, it will also remove the generated files created by -the Slice translators. +the Slice compilers. ## Running the Test Suite diff --git a/php/README.md b/php/README.md index 669e471709c..18d106eb679 100644 --- a/php/README.md +++ b/php/README.md @@ -153,9 +153,10 @@ extension = ice.so You can verify that PHP is loading the Ice extension by running the command shown below: + ``` php -m -```` +``` Look for `ice` among the installed modules. Note that your library search path (`LD_LIBRARY_PATH` on Linux or `DYLD_LIBRARY_PATH` on macOS) must include the diff --git a/ruby/README.md b/ruby/README.md index 89e8ec7017d..b362c5475a1 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -23,7 +23,7 @@ operating systems and Ruby versions listed for our [supported platforms][2]. ### Ruby Versions -Ice for Ruby supports Ruby versions 1.8.1 or later. You can use a source or +Ice for Ruby supports Ruby versions 2.0 or later. You can use a source or binary installation of Ruby. If you use an RPM installation, the following packages are required: @@ -42,7 +42,7 @@ If you installed Ruby in a non-standard location, set the `RUBY_HOME` environment variable to the installation directory. For example: ``` export RUBY_HOME=/opt/ruby -```` +``` The build of Ice for Ruby requires that you first build Ice for C++ in the `cpp` subdirectory. @@ -150,18 +150,18 @@ There are two ways to solve this problem: - Change the default security context for the Ice extension using the following command: - ``` - chcon -t texrel_shlib_t /opt/Ice/ruby/IceRuby.so - ``` +``` +chcon -t texrel_shlib_t /opt/Ice/ruby/IceRuby.so +``` Replace `/opt/Ice` with your installation directory. - Disable SELinux completely by adding the following line to your `/etc/sysconfig/selinux` file: - ``` - SELINUX=disabled - ``` +``` +SELINUX=disabled +``` [1]: https://zeroc.com/downloads/ice [2]: https://doc.zeroc.com/ice/3.7/release-notes/supported-platforms-for-ice-3-7-3 diff --git a/swift/README.md b/swift/README.md index d11d1ad20b1..3fc8a06ba17 100644 --- a/swift/README.md +++ b/swift/README.md @@ -70,4 +70,4 @@ python allTests.py --config Debug --platform iphonesimulator depending on your target. [1]: https://zeroc.com/downloads//ice#swift -[2]: https://doc.zeroc.com/ice/latest/release-notes/supported-platforms-for-ice-3-7-swift +[2]: https://doc.zeroc.com/ice/3.7/release-notes/supported-platforms-for-ice-3-7-3 |