From 4ad770b6c240b677fbb7276030dc5f1b4becc933 Mon Sep 17 00:00:00 2001 From: Jeremy Agostino Date: Thu, 12 Oct 2017 07:56:00 -0400 Subject: [PATCH] Added note about installing tests dependencies on Mac OS X. Added note about tests failing when required architecture support is disabled in build. (#908) --- docs/COMPILE-NIX.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/COMPILE-NIX.md b/docs/COMPILE-NIX.md index d2f378a8..94ce0403 100644 --- a/docs/COMPILE-NIX.md +++ b/docs/COMPILE-NIX.md @@ -153,8 +153,14 @@ of corresponding languages. [8] Unit tests +Mac OS X users will also need the GNU version of binutils (for gobjcopy). +It can be easily installed with Homebrew: `brew install binutils`. + Automated unit tests use the cmocka unit testing framework (https://cmocka.org/). It can be installed in most Linux distros using the package manager, e.g. -`sudo yum install libcmocka libcmocka-devel`, or you can easily build and install it from source. +`sudo yum install libcmocka libcmocka-devel`. +On Mac OS X with Homebrew: `brew install cmocka`. +You can also easily build and install it from source. -You can run the tests by running `make test` in the project directory. +You can run the tests by running `make test` in the project directory. If you don't +build some architecture support then the corresponding tests will fail when run.