Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: "Yordan Karadzhov (VMware)" <y.karadz@gmail.com>
To: linux-trace-devel@vger.kernel.org
Cc: "Yordan Karadzhov (VMware)" <y.karadz@gmail.com>
Subject: [PATCH 2/4] kernel-shark: Polish the README file
Date: Wed, 21 Apr 2021 17:51:38 +0300
Message-ID: <20210421145140.95517-3-y.karadz@gmail.com> (raw)
In-Reply-To: <20210421145140.95517-1-y.karadz@gmail.com>

Fixing some typos and making it easier to read.

Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
 README | 32 +++++++++++++++++---------------
 1 file changed, 17 insertions(+), 15 deletions(-)

diff --git a/README b/README
index f5035f9..b1934c3 100644
--- a/README
+++ b/README
@@ -7,7 +7,8 @@ The official repository is here:
 Third Party Software:
 ------------------------------------------------------------
 KernelShark has the following external dependencies:
-  Cmake, Json-C, OpenGL/Glut, Qt5Base, libtraceevent, libtracefs, trace-cmd.
+  Cmake, Json-C, OpenGL/Glut, Qt5Base, libtraceevent, libtracefs, trace-cmd
+  and FreeSans font.
 
 1. In order to install the packages on Ubuntu do the following:
     sudo apt-get install build-essential git cmake libjson-c-dev -y
@@ -15,7 +16,7 @@ KernelShark has the following external dependencies:
     sudo apt-get install fonts-freefont-ttf
     sudo apt-get install qtbase5-dev -y
 
-1.1 I you want to be able to generate Doxygen documentation:
+1.1 If you want to be able to generate Doxygen documentation:
     sudo apt-get install graphviz doxygen-gui -y
 
 
@@ -24,7 +25,7 @@ KernelShark has the following external dependencies:
     dnf install freeglut-devel redhat-rpm-config -y
     dnf install qt5-qtbase-devel -y
 
-2.1 I you want to be able to generate Doxygen documentation:
+2.1 If you want to be able to generate Doxygen documentation:
     dnf install graphviz doxygen -y
 
 
@@ -46,26 +47,27 @@ KernelShark has the following external dependencies:
 
 Building:
 ------------------------------------------------------------
-2. Building KernelShark:
+1. Building and install KernelShark GUI:
 
     cd kernel-shark/build
     cmake ../
     make
     sudo ./install_gui.sh
 
-2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
-as a CMake Command-Line option.
+1.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
+as a CMake Command-Line option (see the example below).
 
-2.2 KernelShark has multiple build types. By default, the build type is
+1.2 KernelShark has multiple build types. By default, the build type is
 RelWithDebInfo, which will build a release candidate with debug information.
-To change the type, pass in the option CMAKE_BUILD_TYPE=<type>.
+To change the type, pass in the option CMAKE_BUILD_TYPE=<type> (see the
+example below).
 
     cmake -DCMAKE_BUILD_TYPE=Debug           - for "-g" option
     cmake -DCMAKE_BUILD_TYPE=Release         - for "-O3" option
     cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo  - for "-g -O2" option (default)
     cmake -DCMAKE_BUILD_TYPE=MinSizeRel      - for "-Os" option
 
-2.3 In addition to the standard CMake build types (Debug, Release,
+1.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 "-O3" compiler flag. Package maintainers
 can chose their own compiler flags by providing the corresponding
@@ -74,19 +76,19 @@ CMAKE_XXXX_FLAGS_PACKAGE Command-Line options (see the example below).
 -- Note that when built as a "Package" the RPATH-s of the executables are
 set directly to _INSTALL_PREFIX/lib/kernelshark/
 
-2.4 After building the code "kernel-shark/lib" will contain all libraries
+1.4 After building the code "kernel-shark/lib" will contain all libraries
 and "kernel-shark/bin" will contain all executables.
 
-2.5 Use the script "cmake_clean.sh" if you want to delete all already
+1.5 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
+    ./cmake_clean.sh
 
-2.6 By default, installation prefix is "/usr/local". It can be changed using
--D_INSTALL_PREFIX= as a CMake Command-Line option.
+1.6 By default, installation prefix is "/usr/local". It can be changed using
+-D_INSTALL_PREFIX= as a CMake Command-Line option (see the example below).
 
-2.7 In order to uninstall KernelShark do:
+1.7 In order to uninstall KernelShark do:
     cd kernel-shark/build
     ./cmake_uninstall.sh
 
-- 
2.27.0


  parent reply index

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-21 14:51 [PATCH 0/4] Various minor modifications and fixes toward KS 2.0 Yordan Karadzhov (VMware)
2021-04-21 14:51 ` [PATCH 1/4] kernel-shark: Fix warnings from deprecated Qt APIs Yordan Karadzhov (VMware)
2021-04-21 14:51 ` Yordan Karadzhov (VMware) [this message]
2021-04-21 14:51 ` [PATCH 3/4] kernel-shark: Exclude libkshark-plot from libkshark-devel Yordan Karadzhov (VMware)
2021-04-21 14:51 ` [PATCH 4/4] kernel-shark: Integrate install_libkshark-devel.sh Yordan Karadzhov (VMware)
2021-04-21 15:01 ` [PATCH 0/4] Various minor modifications and fixes toward KS 2.0 Steven Rostedt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210421145140.95517-3-y.karadz@gmail.com \
    --to=y.karadz@gmail.com \
    --cc=linux-trace-devel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-Trace-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-trace-devel/0 linux-trace-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-trace-devel linux-trace-devel/ https://lore.kernel.org/linux-trace-devel \
		linux-trace-devel@vger.kernel.org
	public-inbox-index linux-trace-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-trace-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git