From 8f0aed2dd3e37d8873a350cf5a4577ca0546b62d Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Fri, 13 Jan 2017 13:46:37 -0700 Subject: [PATCH] readme: add a section about CONFIG Change-Id: I5a6cd28ee9a3b37921355af46dafdd0f4b606c1a Signed-off-by: Daniel Verkamp --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 4d7da95cfd..7a955f0039 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,27 @@ FreeBSD: 4) (cd dpdk-16.11 && gmake install T=x86_64-native-bsdapp-clang DESTDIR=.) +Build Configuration +=================== + +Optional components and other build-time configuration are controlled by the `CONFIG` file +in the root SPDK directory. `CONFIG` is a Makefile fragment that may be edited before building to +control which options are enabled. + +Boolean (on/off) options are configured with a 'y' (yes) or 'n' (no). For example, this line of +`CONFIG` controls whether the optional RDMA (libibverbs) support is enabled: + + CONFIG_RDMA?=n + +To enable RDMA, this line of CONFIG may be modified to contain 'y' instead of 'n'. + +Alternatively, `CONFIG` options may also be overrriden on the `make` command line: + + make CONFIG_RDMA=y + +The options specified on the `make` command line take precedence over the default values in +`CONFIG`. + Building ========