From 7aa5aa4b520789331905ce2d35fe3d82dd5ac760 Mon Sep 17 00:00:00 2001 From: Michael McGeagh Date: Thu, 5 Nov 2020 16:52:55 +0000 Subject: MLBEDSW-3380 Update readme with build flags mlw_codec is part of the codebase and has build flags. README has been updated to include these. Also, added -Werror to the list, as we must build without any warnings, so treat warnings as errors. Signed-off-by: Michael McGeagh Change-Id: I10114bb013fad1ec1685fafc2e41c18ff12d9f9d --- README.md | 13 +++++++++++-- ethosu/mlw_codec/makefile | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 54e3cbfa..84624bf3 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,7 @@ The following should be installed prior to the installation of Vela: * Python >= 3.6 * Pip3 -* GNU toolchain (GCC, Binutils and libraries) or alternative C compiler/linker -toolchain +* GNU toolchain (GCC, Binutils and libraries) And optionally: @@ -105,6 +104,16 @@ If you plan to contribute to the Vela project (highly encouraged!) then it is recommended to install Vela along with the pre-commit tools (see [Vela Testing](TESTING.md) for more details). +### `mlw_codec` + +As part of the installation process, Vela will compile a C based module. + +The build flags used for this module are as follows: + +```none +-Wall -Werror -Wno-unused-function -Wno-unused-variable +``` + ## Running Vela is run with an input `.tflite` file passed on the command line. This file diff --git a/ethosu/mlw_codec/makefile b/ethosu/mlw_codec/makefile index 6eb418dd..68eb0d94 100644 --- a/ethosu/mlw_codec/makefile +++ b/ethosu/mlw_codec/makefile @@ -20,7 +20,7 @@ UNAME=$(shell uname -o) -CFLAGS=-Wall -Wno-unused-function -Wno-unused-variable +CFLAGS=-Wall -Werror -Wno-unused-function -Wno-unused-variable ifeq ($(DEBUG),1) CFLAGS+=-g -O0 -DDEBUG -- cgit v1.2.1