From: Maryam Tahhan <maryam.tahhan@intel.com>
Date: Fri, 20 Jan 2017 20:06:21 +0000 (+0000)
Subject: docs: add missing info to userguide
X-Git-Tag: danube.1.0~22
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F17%2F27317%2F3;p=barometer.git

docs: add missing info to userguide

Add missing steps for intel_rdt and mcelog plugins to userguide.

Change-Id: I5315dc6a8961cdab57b726e1ecfbe206dce7a976
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
---

diff --git a/docs/userguide/collectd.userguide.rst b/docs/userguide/collectd.userguide.rst
index d86eb32c..1030e46e 100644
--- a/docs/userguide/collectd.userguide.rst
+++ b/docs/userguide/collectd.userguide.rst
@@ -214,10 +214,16 @@ Building and installing PQoS/Intel RDT library:
 .. code:: bash
 
     $ git clone https://github.com/01org/intel-cmt-cat.git
-    $ cd intel-cmt-cat.git
+    $ cd intel-cmt-cat
     $ make
     $ make install PREFIX=/usr
 
+You will need to insert the msr kernel module:
+
+.. code:: bash
+
+    $ modprobe msr
+
 Building and installing collectd:
 
 .. code:: bash
@@ -364,6 +370,18 @@ A utility to inject corrected, uncorrected and fatal machine check exceptions
     $ cd mce-inject
     $ make
     $ modprobe mce-inject
+
+Modify the test/corrected script to include the following:
+
+.. code:: bash
+
+    CPU 0 BANK 0
+    STATUS 0xcc00008000010090
+    ADDR 0x0010FFFFFFF
+
+Inject the error:
+.. code:: bash
+
     $ ./mce-inject < test/corrected
 
 **Note: the uncorrected and fatal scripts under test will cause a platform reset.