diff mbox

ndctl: update readme with build instructions

Message ID 20151110233143.23392.19147.stgit@dwillia2-desk3.jf.intel.com (mailing list archive)
State Accepted
Commit 85428ad1f132
Headers show

Commit Message

Dan Williams Nov. 10, 2015, 11:31 p.m. UTC 
Also, update the minimum CMA reservation size given the new hotplug test
arriving in the 4.4 kernel.

Signed-off-by: Dan Williams <dan.j.williams@intel.com>
---
 README.md |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
diff mbox

Patch

diff --git a/README.md b/README.md
index 84b8ed175f4f..3f62adce2f92 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,15 @@ 
 Utility library for managing the libnvdimm (non-volatile memory device)
 sub-system in the Linux kernel
   
+
+Build
+=====
+`./autogen.sh`  
+`./configure --enable-local`  
+`make`  
+`make check`  
+`sudo make install`  
+
 Documentation
 =============
 See the latest documentation for the NVDIMM kernel sub-system here:
@@ -21,9 +30,9 @@  git://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git`
    memory allocator).
 This will be used to emulate DAX.  
 `CONFIG_DMA_CMA=y`  
-`CONFIG_CMA_SIZE_MBYTES=150`  
+`CONFIG_CMA_SIZE_MBYTES=200`  
 **or**  
-`cma=150M` on the kernel command line.  
+`cma=200M` on the kernel command line.  
 
 3. Compile all components of the libnvdimm sub-system as modules:  
 `CONFIG_LIBNVDIMM=m`