[5/7] kernel-shark-qt: Add a README file to trace-cmd/kernel-shark-qt
diff mbox series

Message ID 20180625150121.14291-6-y.karadz@gmail.com
State New, archived
Headers show
Series
  • Introduce the very basic part of the C API of KS-1.0
Related show

Commit Message

Yordan Karadzhov (VMware) June 25, 2018, 3:01 p.m. UTC
The README file contains instructions for building and using the Qt-based
version of KernelShark.

Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
 kernel-shark-qt/README | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 kernel-shark-qt/README

Comments

Steven Rostedt June 25, 2018, 6:38 p.m. UTC | #1
On Mon, 25 Jun 2018 18:01:19 +0300
"Yordan Karadzhov (VMware)" <y.karadz@gmail.com> wrote:

> +++ b/kernel-shark-qt/README
> @@ -0,0 +1,37 @@
> +
> +This directory contains the new Qt-based version of the KernelShark GUI.
> +
> +
> +Third Party Software:
> +------------------------------------------------------------
> +The external dependencies:
> +1. In order to install the packages on Ubuntu do the following:
> +    sudo apt-get install build-essential git cmake -y
> +
> +2. In order to install the packages on Fedora, as root do the following:
> +    dnf install gcc gcc-c++ git cmake -y

I'm not so sure how useful this "third party software" section is. I
think it's pretty obvious that gcc, c++ and cmake will be needed.


> +
> +
> +Building:
> +------------------------------------------------------------
> +1. Follow the instructions given in trace-cmd/README and build
> +the original trace-cmd end traceevent libraries.
> +
> +2. Do:
> +    cd kernel-shark-qt/build
> +    cmake ../
> +    make
> +
> +2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
> +as a CMake Command-Line option.
> +    cd kernel-shark-qt/build
> +    cmake -D_DOXYGEN_DOC=1 ../
> +    make
> +
> +2.2.1 Use "make clean" if you want to delete all already compiled object.
> +
> +2.2.2 Use the script "cmake_clean.sh" if you want to delete all already
> +compiled object and all files generated by CMake.
> +
> +3. After building the code "kernel-shark-qt/lib" will contain all libraries
> +and "kernel-shark-qt/bin" will contain all executables.

Note, after all the code is in the repo, I expect to have the top level
Makefile, do all the cmake work for the user.

-- Steve
Yordan Karadzhov (VMware) June 26, 2018, 2:51 p.m. UTC | #2
On 25.06.2018 21:38, Steven Rostedt wrote:
> On Mon, 25 Jun 2018 18:01:19 +0300
> "Yordan Karadzhov (VMware)" <y.karadz@gmail.com> wrote:
> 
>> +++ b/kernel-shark-qt/README
>> @@ -0,0 +1,37 @@
>> +
>> +This directory contains the new Qt-based version of the KernelShark GUI.
>> +
>> +
>> +Third Party Software:
>> +------------------------------------------------------------
>> +The external dependencies:
>> +1. In order to install the packages on Ubuntu do the following:
>> +    sudo apt-get install build-essential git cmake -y
>> +
>> +2. In order to install the packages on Fedora, as root do the following:
>> +    dnf install gcc gcc-c++ git cmake -y
> 
> I'm not so sure how useful this "third party software" section is. I
> think it's pretty obvious that gcc, c++ and cmake will be needed.
> 

I would like to have here instructions how to build the code on a 
default out-of-the-box installation of Ubuntu or Fedora. I agree that it 
doesn't make sense as it is right now, but it will start making sense 
when we start adding more and more dependencies.

> 
>> +
>> +
>> +Building:
>> +------------------------------------------------------------
>> +1. Follow the instructions given in trace-cmd/README and build
>> +the original trace-cmd end traceevent libraries.
>> +
>> +2. Do:
>> +    cd kernel-shark-qt/build
>> +    cmake ../
>> +    make
>> +
>> +2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
>> +as a CMake Command-Line option.
>> +    cd kernel-shark-qt/build
>> +    cmake -D_DOXYGEN_DOC=1 ../
>> +    make
>> +
>> +2.2.1 Use "make clean" if you want to delete all already compiled object.
>> +
>> +2.2.2 Use the script "cmake_clean.sh" if you want to delete all already
>> +compiled object and all files generated by CMake.
>> +
>> +3. After building the code "kernel-shark-qt/lib" will contain all libraries
>> +and "kernel-shark-qt/bin" will contain all executables.
> 
> Note, after all the code is in the repo, I expect to have the top level
> Makefile, do all the cmake work for the user.
> 

Do you mean, you want to completely remove this README file?

Thanks!
Yordan


> -- Steve
>
Steven Rostedt June 26, 2018, 3:18 p.m. UTC | #3
On Tue, 26 Jun 2018 17:51:07 +0300
"Yordan Karadzhov (VMware)" <y.karadz@gmail.com> wrote:


> > I'm not so sure how useful this "third party software" section is. I
> > think it's pretty obvious that gcc, c++ and cmake will be needed.
> >   
> 
> I would like to have here instructions how to build the code on a 
> default out-of-the-box installation of Ubuntu or Fedora. I agree that it 
> doesn't make sense as it is right now, but it will start making sense 
> when we start adding more and more dependencies.

OK, I'm just worried about maintaining it.

> > Note, after all the code is in the repo, I expect to have the top level
> > Makefile, do all the cmake work for the user.
> >   
> 
> Do you mean, you want to completely remove this README file?
> 

We may not need to, if it can still be built separately. But ideally, I
want people to simply type "make gui" at the top level and it does
everything (cmake and all). I don't think that will be to difficult to
implement. I was actually planning on doing the implementation myself.

-- Steve

Patch
diff mbox series

diff --git a/kernel-shark-qt/README b/kernel-shark-qt/README
new file mode 100644
index 0000000..7cae9ed
--- /dev/null
+++ b/kernel-shark-qt/README
@@ -0,0 +1,37 @@ 
+
+This directory contains the new Qt-based version of the KernelShark GUI.
+
+
+Third Party Software:
+------------------------------------------------------------
+The external dependencies:
+1. In order to install the packages on Ubuntu do the following:
+    sudo apt-get install build-essential git cmake -y
+
+2. In order to install the packages on Fedora, as root do the following:
+    dnf install gcc gcc-c++ git cmake -y
+
+
+Building:
+------------------------------------------------------------
+1. Follow the instructions given in trace-cmd/README and build
+the original trace-cmd end traceevent libraries.
+
+2. Do:
+    cd kernel-shark-qt/build
+    cmake ../
+    make
+
+2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
+as a CMake Command-Line option.
+    cd kernel-shark-qt/build
+    cmake -D_DOXYGEN_DOC=1 ../
+    make
+
+2.2.1 Use "make clean" if you want to delete all already compiled object.
+
+2.2.2 Use the script "cmake_clean.sh" if you want to delete all already
+compiled object and all files generated by CMake.
+
+3. After building the code "kernel-shark-qt/lib" will contain all libraries
+and "kernel-shark-qt/bin" will contain all executables.