[v2,1/3] kernelshark: Update the README for changes to the make process

Commit Message

Steven Rostedt June 27, 2019, 5:05 p.m. UTC

From: "Steven Rostedt (VMware)" <[e-mail]>

The top level git tree's Makefile has code added to build the cmake portion
of KernelShark. But the README does not document the process. Bring the
README up to speed with how to actually build KernelShark.

Signed-off-by: Steven Rostedt (VMware) <[e-mail]>
---
 kernel-shark/README | 50 ++++++++++++++++++++++++++++++++++++---------
 1 file changed, 40 insertions(+), 10 deletions(-)

Patch

diff --git a/kernel-shark/README b/kernel-shark/README
index 75a0dd08dcac..7155e13b17fc 100644
--- a/kernel-shark/README
+++ b/kernel-shark/README
@@ -30,18 +30,47 @@  Building:
 1. Follow the instructions given in trace-cmd/README and build
 the original trace-cmd end traceevent libraries.
 
-2. Do:
-    cd kernel-shark/build
-    cmake ../
-    make
+2. Building KernelShark:
+
+2.1 There is a simple and expert way to build KernelShark
+
+2.1.1 Option 1 (simple) : build KernelShark as part of trace-cmd
+
+   (from the toplevel git tree)
+
+      make gui
+
+   This will build the necessary parts of trace-cmd needed
+   by KernelShark.
+
+2.1.1.1 By default, the installation prefix is "/usr/local". It can be
+changed by passing in "prefix" to the build.
+
+   make prefix=/usr gui
 
-2.1.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
+2.1.1.2 Use "make clean" if you want to delete all already compiled objects.
+Note, this will not clean up the files created by cmake. See section 2.1.2.4
+
+2.1.2 Option 2 (expert) : standalone build of KernelShark (for hackers only)
+
+   (note, you may need to do a normal make from the toplevel git
+    tree before performing the following)
+
+      make
+      cd kernel-shark/build
+      cmake ../
+      make
+
+    This gives you a bit more control as you may easily pass in
+    your own cmake options.
+
+2.1.2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
 as a CMake Command-Line option.
 
-2.1.2 By default, installation prefix is "/usr/local". It can be changed using
+2.1.2.2 By default, installation prefix is "/usr/local". It can be changed using
 -D_INSTALL_PREFIX= as a CMake Command-Line option.
 
-2.1.3 In addition to the standard CMake build types (Debug, Release,
+2.1.2.3 In addition to the standard CMake build types (Debug, Release,
 RelWithDebInfo, MinSizeRel) KernelShark supports a "Package" build type.
 By default this build type adds the "-O2" compiler flag. Package maintainers
 can chose their own compiler flags by providing the corresponding
@@ -57,10 +86,11 @@  Examples:
 
     cmake -DCMAKE_BUILD_TYPE=Package -DCMAKE_C_FLAGS_PACKAGE="-O3 -pedantic"  ../
 
-2.2.1 Use "make clean" if you want to delete all already compiled objects.
-
-2.2.2 Use the script "cmake_clean.sh" if you want to delete all already
+2.1.2.4 Use the script "cmake_clean.sh" if you want to delete all already
 compiled objects and all files generated by CMake.
 
+    cd kernel-shark/build
+    ./cmake-clean.sh
+
 3. After building the code "kernel-shark/lib" will contain all libraries
 and "kernel-shark/bin" will contain all executables.