Skip to content

Latest commit

 

History

History
169 lines (114 loc) · 5.67 KB

dependencies.md

File metadata and controls

169 lines (114 loc) · 5.67 KB
Raw

Build Dependencies for Linux and macOS

Building .NET for Android requires:

The make prepare build step (or /t:Prepare on Windows) will check that all required dependencies are present. If you would like make prepare to automatically install required dependencies, set the $(AutoProvision) MSBuild property to True and (if necessary) set the $(AutoProvisionUsesSudo) property to True. (This is not supported on all operating systems; see configuration.md for details.)

If $(AutoProvision) is False (the default) and a dependency is missing, then the build will fail and an error message will be displayed attempting to provide install instructions to obtain the missing dependency, e.g.:

error : Could not find required program '7za'. Please run: brew install 'p7zip'.

Homebrew

Homebrew must be installed and available via $PATH in order to provision xamarin-android.

When building on Apple Silicon (arm64) machines, use the arch(1) command to allow Homebrew to be installed:

% arch -arch x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Mono MDK

Latest Mono is required to build on macOS and Linux. The build will tell you if your version is outdated.

The minimum Mono version which is checked for can be overridden by the $(MonoRequiredMinimumVersion) MSBuild property, but things may not build. (This is your warning.)

Java Development Kit

Most Linux distributions include OpenJDK. Alternatively, the Java Development Kit may be downloaded from the Oracle Java SE Downloads page.

At this time, we only support building with JDK 1.8.

Autotools

Autotools -- including autoconf and automake -- are required to build the Mono runtimes.

On macOS, autotools are should be used from brew, and may be installed via:

brew install automake

Android NDK, SDK

Note: A xamarin-android checkout maintains its own Android NDK + SDK to ensure consistent builds and build behavior, permitting reproducible builds and providing greater flexibility around when we need to perform Android SDK + NDK updates. The Android SDK and NDK are maintained by default via two directories in your home directory:

  • $(AndroidToolchainCacheDirectory): Where downloaded files are cached. Defaults to the $HOME/android-archives directory.
  • $(AndroidToolchainDirectory): Where the Android NDK and SDK are installed. Defaults to the $HOME/android-toolchain directory.

Developers may use these directories for their own use, but please DO NOT update or alter the contents of the $(AndroidToolchainDirectory), as that may prevent the xamarin-android build from working as expected.

The files that will be downloaded and installed are controlled by build-tools/android-toolchain/android-toolchain.projitems via the @(AndroidNdkItem) and @(AndroidSdkItem) item groups, and the URL to download files from is controlled by the $(AndroidUri) property.

Linux Dependencies

If you have the binfmt_misc module enabled with any of Mono or Wine installed and you plan to cross-build the Windows compilers and tools (by enabling the mxe-Win32 or mxe-Win64 host targets) as well as LLVM+AOT targets, you will need to disable binfmt_misc for the duration of the build or the Mono/LLVM configure scripts will fail to detect they are cross-compiling and they will produce Windows PE executables for tools required by the build.

To disable binfmt_misc you need to issue the following command as root:

echo 0 > /proc/sys/fs/binfmt_misc/status

and to enable it again, issue the following command:

echo 1 > /proc/sys/fs/binfmt_misc/status

macOS Dependencies

The android-toolchain.projitems, among others, use the @(RequiredProgram) build action to check for the existence of a program within $PATH during the build. If a required program doesn't exist, then the build will fail and a suggested brew install command line will be provided to install the missing commands.

Brew Programs

Suggested brew install commands:

brew install cmake
brew install libtool
brew install p7zip
brew install gdk-pixbuf
brew install gettext
brew install coreutils
brew install findutils
brew install gnu-tar
brew install gnu-sed
brew install gawk
brew install gnutls
brew install gnu-indent
brew install gnu-getopt
brew install intltool
brew install ninja
brew install scons
brew install wget
brew install xz

If any program is still not found, try to ensure it's linked via:

brew link <package name>