aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorfuzzard <fuzzard@kodi.tv>2022-05-05 09:30:06 +1000
committerfuzzard <fuzzard@kodi.tv>2022-05-05 09:30:06 +1000
commit6e8bf3b33a72c44a7a22cf10fade21fab33e5a65 (patch)
treeb803c4dfa9d039ddfda1a08fde143373364ea441 /docs
parent6d22760629bf9c7d22ab7c3560a2b37cdec19d10 (diff)
[Docs] List configure options for Apple/Android platforms
Diffstat (limited to 'docs')
-rw-r--r--docs/README.Android.md86
-rw-r--r--docs/README.iOS.md77
-rw-r--r--docs/README.macOS.md80
-rw-r--r--docs/README.tvOS.md75
4 files changed, 314 insertions, 4 deletions
diff --git a/docs/README.Android.md b/docs/README.Android.md
index aa952051d4..08e5cfefde 100644
--- a/docs/README.Android.md
+++ b/docs/README.Android.md
@@ -15,7 +15,8 @@ It should work if you're using macOS. If that is the case, read **[macOS specifi
3.4. **[Create a key to sign debug APKs](#34-create-a-key-to-sign-debug-apks)**
3.5. **[macOS specific prerequisites](#35-macos-specific-prerequisites)**
4. **[Get the source code](#4-get-the-source-code)**
-5. **[Build tools and dependencies](#5-build-tools-and-dependencies)**
+5. **[Build tools and dependencies](#5-build-tools-and-dependencies)**
+ 5.1. **[Advanced Configure Options](#51-advanced-configure-options)**
6. **[Build binary add-ons](#6-build-binary-add-ons)**
7. **[Build Kodi](#7-build-kodi)**
8. **[Package](#8-package)**
@@ -170,6 +171,89 @@ make -j$(getconf _NPROCESSORS_ONLN)
**WARNING:** Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again.
+### 5.1. Advanced Configure Options
+
+
+**All platforms:**
+
+```
+--with-toolchain=<path>
+```
+ specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux
+
+```
+--enable-debug=<yes:no>
+```
+ enable debugging information (default is yes)
+
+```
+--disable-ccache
+```
+ disable ccache
+
+```
+--with-tarballs=<path>
+```
+ path where tarballs will be saved [prefix/xbmc-tarballs]
+
+```
+--with-cpu=<cpu>
+```
+ optional. specify target cpu. guessed if not specified
+
+```
+--with-linker=<linker>
+```
+ specify linker to use. (default is ld)
+
+```
+--with-platform=<platform>
+```
+ target platform
+
+```
+--enable-gplv3=<yes:no>
+```
+ enable gplv3 components. (default is yes)
+
+```
+--with-target-cflags=<cflags>
+```
+ C compiler flags (target)
+
+```
+--with-target-cxxflags=<cxxflags>
+```
+ C++ compiler flags (target)
+
+```
+--with-target-ldflags=<ldflags>
+```
+ linker flags. Use e.g. for -l<lib> (target)
+
+```
+--with-ffmpeg-options
+```
+ FFmpeg configure options, e.g. --enable-vaapi (target)
+
+
+**Android Specific:**
+
+```
+--with-ndk-api=<ndk number>
+```
+ specify ndk level (optional for android), default is 21.]
+
+```
+--with-ndk-path=<path>
+```
+ specify path to ndk (required for android only)
+
+```
+--with-sdk-path=<path>
+```
+ specify path to sdk (required for android only)
+
**[back to top](#table-of-contents)** | **[back to section top](#5-build-tools-and-dependencies)**
diff --git a/docs/README.iOS.md b/docs/README.iOS.md
index a7fc56b0bb..7bb9cfce3d 100644
--- a/docs/README.iOS.md
+++ b/docs/README.iOS.md
@@ -7,7 +7,8 @@ This guide has been tested using Xcode 11.3.1 running on MacOS 10.14.4 (Mojave).
1. **[Document conventions](#1-document-conventions)**
2. **[Prerequisites](#2-prerequisites)**
3. **[Get the source code](#3-get-the-source-code)**
-4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
+4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
+ 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)**
5. **[Build binary add-ons](#5-build-binary-add-ons)**
5.1. **[Independent Add-on building](#51-Independent-Add-on-building)**
5.2. **[Xcode project building](#52-Xcode-project-building)**
@@ -104,6 +105,80 @@ make -j$(getconf _NPROCESSORS_ONLN)
./configure --host=aarch64-apple-darwin --with-platform=ios --with-sdk=11.0
```
+### 4.1. Advanced Configure Options
+
+
+**All platforms:**
+
+```
+--with-toolchain=<path>
+```
+ specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux
+
+```
+--enable-debug=<yes:no>
+```
+ enable debugging information (default is yes)
+
+```
+--disable-ccache
+```
+ disable ccache
+
+```
+--with-tarballs=<path>
+```
+ path where tarballs will be saved [prefix/xbmc-tarballs]
+
+```
+--with-cpu=<cpu>
+```
+ optional. specify target cpu. guessed if not specified
+
+```
+--with-linker=<linker>
+```
+ specify linker to use. (default is ld)
+
+```
+--with-platform=<platform>
+```
+ target platform
+
+```
+--enable-gplv3=<yes:no>
+```
+ enable gplv3 components. (default is yes)
+
+```
+--with-target-cflags=<cflags>
+```
+ C compiler flags (target)
+
+```
+--with-target-cxxflags=<cxxflags>
+```
+ C++ compiler flags (target)
+
+```
+--with-target-ldflags=<ldflags>
+```
+ linker flags. Use e.g. for -l<lib> (target)
+
+```
+--with-ffmpeg-options
+```
+ FFmpeg configure options, e.g. --enable-vaapi (target)
+
+
+**Apple Specific:**
+
+```
+--with-sdk=<sdknumber>
+```
+ specify sdk platform version.
+
+
**[back to top](#table-of-contents)** | **[back to section top](#4-configure-and-build-tools-and-dependencies)**
## 5. Build binary add-ons
diff --git a/docs/README.macOS.md b/docs/README.macOS.md
index 7aac497e9e..7723671d20 100644
--- a/docs/README.macOS.md
+++ b/docs/README.macOS.md
@@ -7,7 +7,8 @@ This guide has been tested using Xcode 11.3.1 running on MacOS 10.14.4 (Mojave).
1. **[Document conventions](#1-document-conventions)**
2. **[Prerequisites](#2-prerequisites)**
3. **[Get the source code](#3-get-the-source-code)**
-4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
+4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
+ 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)**
5. **[Build binary add-ons](#5-build-binary-add-ons)**
6. **[Build Kodi](#6-build-kodi)**
6.1. **[Build with Xcode](#61-build-with-xcode)**
@@ -116,6 +117,83 @@ Developers can also select native windowing/input handling with the following
./configure --host=x86_64-apple-darwin --with-platform=macos --with-windowsystem=native
```
+### 4.1. Advanced Configure Options
+
+
+**All platforms:**
+
+```
+--with-toolchain=<path>
+```
+ specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux
+
+```
+--enable-debug=<yes:no>
+```
+ enable debugging information (default is yes)
+
+```
+--disable-ccache
+```
+ disable ccache
+
+```
+--with-tarballs=<path>
+```
+ path where tarballs will be saved [prefix/xbmc-tarballs]
+
+```
+--with-cpu=<cpu>
+```
+ optional. specify target cpu. guessed if not specified
+
+```
+--with-linker=<linker>
+```
+ specify linker to use. (default is ld)
+
+```
+--with-platform=<platform>
+```
+ target platform
+
+```
+--enable-gplv3=<yes:no>
+```
+ enable gplv3 components. (default is yes)
+
+```
+--with-target-cflags=<cflags>
+```
+ C compiler flags (target)
+
+```
+--with-target-cxxflags=<cxxflags>
+```
+ C++ compiler flags (target)
+
+```
+--with-target-ldflags=<ldflags>
+```
+ linker flags. Use e.g. for -l<lib> (target)
+
+```
+--with-ffmpeg-options
+```
+ FFmpeg configure options, e.g. --enable-vaapi (target)
+
+**Apple Specific:**
+
+```
+--with-windowsystem=<native:sdl>
+```
+ Windowing system to use (default is sdl when not provided). arm64 MacOS requires native
+
+```
+--with-sdk=<sdknumber>
+```
+ specify sdk platform version.
+
**[back to top](#table-of-contents)** | **[back to section top](#4-configure-and-build-tools-and-dependencies)**
## 5. Build binary add-ons
diff --git a/docs/README.tvOS.md b/docs/README.tvOS.md
index 11204b118f..e642d37072 100644
--- a/docs/README.tvOS.md
+++ b/docs/README.tvOS.md
@@ -7,7 +7,8 @@ This guide has been tested using Xcode 11.3.1 running on MacOS 10.15.2 (Catalina
1. **[Document conventions](#1-document-conventions)**
2. **[Prerequisites](#2-prerequisites)**
3. **[Get the source code](#3-get-the-source-code)**
-4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
+4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
+ 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)**
5. **[Generate Kodi Build files](#5-Generate-Kodi-Build-files)**
5.1. **[Generate XCode Project Files](#51-Generate-Xcode-Project-Files)**
5.2. **[Build with Xcode](#62-build)**
@@ -109,6 +110,78 @@ make -j$(getconf _NPROCESSORS_ONLN)
./configure --host=aarch64-apple-darwin --with-platform=tvos --with-sdk=11.0
```
+### 4.1. Advanced Configure Options
+
+
+**All platforms:**
+
+```
+--with-toolchain=<path>
+```
+ specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux
+
+```
+--enable-debug=<yes:no>
+```
+ enable debugging information (default is yes)
+
+```
+--disable-ccache
+```
+ disable ccache
+
+```
+--with-tarballs=<path>
+```
+ path where tarballs will be saved [prefix/xbmc-tarballs]
+
+```
+--with-cpu=<cpu>
+```
+ optional. specify target cpu. guessed if not specified
+
+```
+--with-linker=<linker>
+```
+ specify linker to use. (default is ld)
+
+```
+--with-platform=<platform>
+```
+ target platform
+
+```
+--enable-gplv3=<yes:no>
+```
+ enable gplv3 components. (default is yes)
+
+```
+--with-target-cflags=<cflags>
+```
+ C compiler flags (target)
+
+```
+--with-target-cxxflags=<cxxflags>
+```
+ C++ compiler flags (target)
+
+```
+--with-target-ldflags=<ldflags>
+```
+ linker flags. Use e.g. for -l<lib> (target)
+
+```
+--with-ffmpeg-options
+```
+ FFmpeg configure options, e.g. --enable-vaapi (target)
+
+**Apple Specific:**
+
+```
+--with-sdk=<sdknumber>
+```
+ specify sdk platform version.
+
**[back to top](#table-of-contents)**
## 5. Generate Kodi Build files