The CHIP build system uses GNU autotools to build various platform images on Linux or macOS.
Note: CHIP has brought up GN which builds much faster. See BUILDING-GN.md Please try the new flow and report any problems.
Tested on:
Build system features:
Assuming you have all the required tools installed, the system will build the code, build a distribution, tidy, format, run tests, and run code coverage on the entire tree. Tests are built into the make system.
To take advantage of all the current capabilities of the make system, you'll want:
On Debian-based Linux distributions such as Ubuntu, these dependencies can be satisfied with the following:
sudo apt-get install make autoconf automake libtool pkg-config sudo apt-get install clang-format-9 sudo apt-get install lcov
On macOS, these dependencies can be installed and satisfied using Brew:
brew install make autoconf automake libtool pkg-config brew install llvm@9 brew install lcov
The CHIP build currently requires the OpenSSL. This should be installed and visible to pkg-config.
On Debian-based Linux distributions such as Ubuntu, these dependencies can be satisfied with the following:
sudo apt-get install openssl
On macOS, these dependencies can be satisfied using Brew:
brew install openssl
However, that does not expose the package to pkg-config. To fix that, one needs to run something like the following:
cd /usr/local/lib/pkgconfig ln -s ../../Cellar/openssl@1.1/1.1.1g/lib/pkgconfig/* .
where openssl@1.1/1.1.1g may need to be replaced with the actual version of OpenSSL installed by Brew.
Note: If using MacPorts, port install openssl is sufficient to satisfy this dependency.
Before running any other build command, the ./bootstrap command must be run from the top-level.
# Initial preparation ./bootstrap
This will build all sources, libraries, and tests for the given platform:
# From top of clean tree ./bootstrap make -f Makefile-Standalone
The helper Makefile-<platform> will automatically run configure the using a default set of parameters, and allow custom override parameters to be passed via environment variables. An example of this follows:
TESTS=1 DEBUG=1 COVERAGE=1 make -f Makefile-Standalone
At any time after this if a Makefile.am is updated, ./bootstrap -w make must be run again for the changes to be picked up.
# From top of clean tree ./bootstrap mkdir build/<CONFIG> cd build/<CONFIG> ../../configure -C <CONFIG ARGUMENTS>
Where <CONFIG> is something that describes what configuration (as described by <CONFIG ARGUMENTS>) of the tree you‘re planning to build, or simply out if you’re not feeling creative.
make
make dist
make distcheck
make check
make pretty-check
make pretty
To build the documentation bundle using Doxygen, run the following:
make docdist
The top of the browsable web documentation can be found in docs/html/index.html.
Either enter the desired subdirectory directly and run make or pass the desired subdirectory to make -C.
$ make -C src/system Making all in tests make[1]: Entering directory 'src/system/tests' make[1]: Nothing to be done for 'all'. make[1]: Leaving directory 'src/system/tests' make[1]: Entering directory 'src/system' CXX ../../src/system/libSystemLayer_a-SystemClock.o CXX ../../src/system/libSystemLayer_a-SystemError.o CXX ../../src/system/libSystemLayer_a-SystemLayer.o CXX ../../src/system/libSystemLayer_a-SystemMutex.o CXX ../../src/system/libSystemLayer_a-SystemObject.o CXX ../../src/system/libSystemLayer_a-SystemTimer.o CXX ../../src/system/libSystemLayer_a-SystemPacketBuffer.o CXX ../../src/system/libSystemLayer_a-SystemStats.o CXX ../../src/system/libSystemLayer_a-SystemFaultInjection.o AR libSystemLayer.a ar: `u' modifier ignored since `D' is the default (see `U') make[1]: Leaving directory 'src/system'
To add a new source folder, say under src/<new>, follow these steps:
src/<new> directory and add a new Makefile.am within it.src/Makefile.am and add a reference to the <new> folder under SUBDIRS.AC_CONFIG_FILES in configure.ac to reference the <new>/Makefile (not the Makefile.am).To add new source files to the project, say under src/<module>, follow these steps:
src/<module>src/<module>/Makefile.am under target_SOURCES or target_HEADERS as appropriate../bootstrap -w make at the top-level.This will clear out all build artifacts, including those created by ./bootstrap.
make distclean
If the source has been pulled using git clone the following command can also be used to clear out all build artifacts:
# To clean all intermediate build files from the tree git clean -fdx
Install XCode and XQuarz.
Product > Scheme > CHIP Tool App iOSInstall Android Studio, Java, and NDK.
# Update these paths based on your environment and version of the tools (macOS examples): export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-12.0.1.jdk/Contents/Home export ANDROID_HOME=~/Library/Android/sdk export ANDROID_NDK_HOME=~/Library/Android/sdk/ndk/21.0.6113669 make -f Makefile-Android
The Doxygen documentation is generated automatically if Doxygen is detected on the system. The generated documentation can be found into ${top_builddir}/docs/html where ${top_builddir} varies depending on how the project was built.
On Debian-based Linux distributions such as Ubuntu, Doxygen can be installed with the following:
sudo apt-get install doxygen
On macOS, Doxygen can be installed and satisfied using Brew:
brew install doxygen
If you want to maintain, enhance, extend, or otherwise modify CHIP, it is likely you will need to change its build system, based on GNU autotools, in some circumstances.
After any change to the CHIP build system, including any Makefile.am files or the configure.ac file, you must run the bootstrap or bootstrap-configure (which runs both bootstrap and configure in one shot) script to update the build system.
Due to its leverage of GNU autotools, if you want to modify or otherwise maintain the CHIP build system, the following additional packages are required and are invoked by bootstrap:
Instructions for installing these tools is in the Tool Prerequisites section above.