linux-trace-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: June Knauth <june.knauth@gmail.com>
To: linux-trace-devel@vger.kernel.org
Cc: "June Knauth (VMware)" <june.knauth@gmail.com>
Subject: [PATCH] trace-cruncher: README updates; add Testing, reformat, and fix deps
Date: Fri, 10 Jun 2022 15:55:54 -0700	[thread overview]
Message-ID: <20220610225554.5275-1-june.knauth@gmail.com> (raw)

From: "June Knauth (VMware)" <june.knauth@gmail.com>

This patch covers several small improvements in the README. They are:
1. Removal of the > characters and excess linebreaks to improve readability
2. Addition of two dependencies to the manual install instructions:
binutils-dev and pkg-config.
3. Addition of a "Testing" section

Signed-off-by: June Knauth (VMware) <june.knauth@gmail.com>
---
 README.md | 104 +++++++++++++++++++++---------------------------------
 1 file changed, 40 insertions(+), 64 deletions(-)

diff --git a/README.md b/README.md
index 95cbd8e..cba5495 100644
--- a/README.md
+++ b/README.md
@@ -17,83 +17,59 @@ Trace-Cruncher has the following external dependencies:
 
 1.1 In order to install all packages on Ubuntu do the following:
 
-    > sudo apt-get update
-
-    > sudo apt-get install build-essential git cmake libjson-c-dev -y
-
-    > sudo apt-get install libpython3-dev cython3 python3-numpy python3-pip -y
-
-    > sudo apt-get install flex valgrind -y
-
-    > sudo pip3 install --system pkgconfig GitPython
+    sudo apt-get update
+    sudo apt-get install build-essential git cmake libjson-c-dev -y
+    sudo apt-get install libpython3-dev cython3 python3-numpy python3-pip -y
+    sudo apt-get install flex valgrind binutils-dev pkg-config -y
+    sudo pip3 install --system pkgconfig GitPython
 
 1.2 In order to install all packages on Fedora, as root do the following:
 
-    > sudo dnf install gcc gcc-c++ git cmake json-c-devel -y
-
-    > sudo dnf install python3-devel python3-Cython python3-numpy python3-pip -y
-
-    > sudo dnf install flex valgrind -y
-
-    > sudo pip3 install --system pkgconfig GitPython
-
+    sudo dnf install gcc gcc-c++ git cmake json-c-devel -y
+    sudo dnf install python3-devel python3-Cython python3-numpy python3-pip -y
+    sudo dnf install flex valgrind -y
+    sudo pip3 install --system pkgconfig GitPython
 
 2 In order to install all third party libraries do the following:
 
-    > git clone https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
-
-    > cd libtraceevent
-
-    > make
-
-    > sudo make install
-
-    > cd ..
-
-
-    > git clone https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
-
-    > cd libtracefs
-
-    > make
-
-    > sudo make install
-
-    > cd ..
-
-
-    > git clone https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
-
-    > cd trace-cmd
-
-    > make
-
-    > sudo make install_libs
-
-    > cd ..
-
-
-    > git clone https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-shark.git/
-
-    > cd kernel-shark/build
-
-    > cmake ..
-
-    > make
-
-    > sudo make install
-
-    > cd ../..
+    git clone https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
+    cd libtraceevent
+    make
+    sudo make install
+    cd ..
+
+    git clone https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
+    cd libtracefs
+    make
+    sudo make install
+    cd ..
+
+    git clone https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
+    cd trace-cmd
+    make
+    sudo make install_libs
+    cd ..
+
+    git clone https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-shark.git/
+    cd kernel-shark/build
+    cmake ..
+    make
+    sudo make install
+    cd ../..
 
 ### Build & Run
 
 Installing trace-cruncher is very simple. After downloading the source code, you just have to run:
 
-     > cd trace-cruncher
+    cd trace-cruncher
+    make
+    sudo make install
+
+### Testing
 
-     > make
+To execute the unit tests run the following from the `trace-cruncher/tests` directory:
 
-     > sudo make install
+	sudo python3 -m unittest discover .
 
 ## Documentation
 For questions about the use of Trace-Cruncher, please send email to: linux-trace-users@vger.kernel.org
-- 
2.25.1


             reply	other threads:[~2022-06-10 22:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-10 22:55 June Knauth [this message]
2022-06-13 13:36 ` [PATCH] trace-cruncher: README updates; add Testing, reformat, and fix deps Tzvetomir Stoyanov

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=20220610225554.5275-1-june.knauth@gmail.com \
    --to=june.knauth@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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).