* [PATCH 2/3] trace-cruncher: Update README.md
2021-08-25 9:44 [PATCH 1/3] trace-cruncher: Update CONTRIBUTING.md Yordan Karadzhov (VMware)
@ 2021-08-25 9:44 ` Yordan Karadzhov (VMware)
2021-08-25 9:44 ` [PATCH 3/3] trace-cruncher: Fix the copyright notices Yordan Karadzhov (VMware)
1 sibling, 0 replies; 3+ messages in thread
From: Yordan Karadzhov (VMware) @ 2021-08-25 9:44 UTC (permalink / raw)
To: linux-trace-devel; +Cc: Yordan Karadzhov (VMware)
Improve the the description of the project and make the provided
information consistent with content of CONTRIBUTING.md.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
README.md | 31 +++++++++++++------------------
1 file changed, 13 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 9a3696c..93f12c8 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@
## Overview
-The Trace-Cruncher project aims to provide an interface between the existing instrumentation for collection and visualization of tracing data from the Linux kernel and the broad and very well developed ecosystem of instruments for data analysis available in Python. The interface is based on NumPy.
+The Trace-Cruncher project aims to provide an interface between the existing instrumentation for collection and visualization of tracing data from the Linux kernel and the broad and very well developed ecosystem of instruments for data analysis available in Python.
-NumPy implements an efficient multi-dimensional container of generic data and uses strong typing in order to provide fast data processing in Python. The Trace-Cruncher allows for sophisticated analysis of kernel tracing data via scripts, but it also opens the door for exposing the kernel tracing data to the instruments provided by the scientific toolkit of Python like MatPlotLib, Stats, Scikit-Learn and even to the nowadays most popular frameworks for Machine Learning like TensorFlow and PyTorch. The Trace-Cruncher is strongly coupled to the KernelShark project and is build on top of the C API of libkshark.
+The Trace-Cruncher allows for sophisticated analysis of kernel tracing data via scripts, but it also opens the door for exposing the kernel tracing data to the instruments provided by the scientific toolkit of Python like MatPlotLib, Stats, Scikit-Learn and even to the nowadays most popular frameworks for Machine Learning like TensorFlow and PyTorch. The Trace-Cruncher is strongly coupled to the [libtraceevent](https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git), [libtracefs](https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/) and [KernelShark](https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-shark.git/) projects and is build on top of the C API of this librearies.
## Try it out
@@ -23,13 +23,17 @@ Trace-Cruncher has the following external dependencies:
> 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
1.2 In order to install all packages on Fedora, as root do the following:
- > dnf install gcc gcc-c++ git cmake json-c-devel -y
+ > sudo dnf install gcc gcc-c++ git cmake json-c-devel -y
+
+ > sudo dnf install python3-devel python3-Cython python3-numpy python3-pip -y
- > dnf install python3-devel python3-Cython python3-numpy python3-pip -y
+ > sudo dnf install flex valgrind -y
> sudo pip3 install --system pkgconfig GitPython
@@ -58,17 +62,6 @@ Trace-Cruncher has the following external dependencies:
> 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://github.com/yordan-karadzhov/kernel-shark-v2.beta.git kernel-shark
> cd kernel-shark/build
@@ -92,14 +85,16 @@ Installing trace-cruncher is very simple. After downloading the source code, you
> sudo make install
## Documentation
+For questions about the use of Trace-Cruncher, please send email to: linux-trace-users@vger.kernel.org
-For bug reports and issues, please file it here:
+[Subscribe](http://vger.kernel.org/vger-lists.html#linux-trace-users) / [Archives](https://lore.kernel.org/linux-trace-users/)
-https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---
+For bug reports and issues, please file it
+[bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---)
## Contributing
-The trace-cruncher project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
+The trace-cruncher project team welcomes contributions from the community. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
## License
--
2.30.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH 3/3] trace-cruncher: Fix the copyright notices
2021-08-25 9:44 [PATCH 1/3] trace-cruncher: Update CONTRIBUTING.md Yordan Karadzhov (VMware)
2021-08-25 9:44 ` [PATCH 2/3] trace-cruncher: Update README.md Yordan Karadzhov (VMware)
@ 2021-08-25 9:44 ` Yordan Karadzhov (VMware)
1 sibling, 0 replies; 3+ messages in thread
From: Yordan Karadzhov (VMware) @ 2021-08-25 9:44 UTC (permalink / raw)
To: linux-trace-devel; +Cc: Yordan Karadzhov (VMware)
Using '(C)' in the text of the copyright notice is no longer required.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
examples/kprobe_open.py | 2 +-
examples/start_tracing.py | 2 +-
src/common.h | 2 +-
src/ftracepy-utils.c | 2 +-
src/ftracepy-utils.h | 2 +-
src/ftracepy.c | 2 +-
src/ksharkpy-utils.c | 2 +-
src/ksharkpy-utils.h | 2 +-
src/ksharkpy.c | 2 +-
tests/0_get_data/test_get_data.py | 2 +-
tests/1_unit/test_01_ftracepy_unit.py | 2 +-
tests/1_unit/test_02_datawrapper_unit.py | 2 +-
tests/1_unit/test_03_ksharkpy_unit.py | 2 +-
tests/2_integration/test_01_ftracepy_integration.py | 2 +-
tests/2_integration/test_03_ksharkpy_integration.py | 2 +-
15 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/examples/kprobe_open.py b/examples/kprobe_open.py
index f8d4d8b..43b4212 100755
--- a/examples/kprobe_open.py
+++ b/examples/kprobe_open.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: CC-BY-4.0
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import sys
diff --git a/examples/start_tracing.py b/examples/start_tracing.py
index da36164..c9960e3 100755
--- a/examples/start_tracing.py
+++ b/examples/start_tracing.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: CC-BY-4.0
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import tracecruncher.ftracepy as ft
diff --git a/src/common.h b/src/common.h
index 476e4f1..abfda1f 100644
--- a/src/common.h
+++ b/src/common.h
@@ -1,7 +1,7 @@
/* SPDX-License-Identifier: LGPL-2.1 */
/*
- * Copyright (C) 2017 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
+ * Copyright 2017 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
*/
#ifndef _TC_COMMON_H
diff --git a/src/ftracepy-utils.c b/src/ftracepy-utils.c
index 8e0ca42..53fc95f 100644
--- a/src/ftracepy-utils.c
+++ b/src/ftracepy-utils.c
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: LGPL-2.1
/*
- * Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+ * Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
*/
#ifndef _GNU_SOURCE
diff --git a/src/ftracepy-utils.h b/src/ftracepy-utils.h
index 26a2f14..218dcb3 100644
--- a/src/ftracepy-utils.h
+++ b/src/ftracepy-utils.h
@@ -1,7 +1,7 @@
/* SPDX-License-Identifier: LGPL-2.1 */
/*
- * Copyright (C) 2021 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
+ * Copyright 2021 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
*/
#ifndef _TC_FTRACE_PY_UTILS
diff --git a/src/ftracepy.c b/src/ftracepy.c
index e5a91fc..f03c488 100644
--- a/src/ftracepy.c
+++ b/src/ftracepy.c
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: LGPL-2.1
/*
- * Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+ * Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
*/
// trace-cruncher
diff --git a/src/ksharkpy-utils.c b/src/ksharkpy-utils.c
index 12972fb..5744a44 100644
--- a/src/ksharkpy-utils.c
+++ b/src/ksharkpy-utils.c
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: LGPL-2.1
/*
- * Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+ * Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
*/
#ifndef _GNU_SOURCE
diff --git a/src/ksharkpy-utils.h b/src/ksharkpy-utils.h
index 6d17d2e..0f11c80 100644
--- a/src/ksharkpy-utils.h
+++ b/src/ksharkpy-utils.h
@@ -1,7 +1,7 @@
/* SPDX-License-Identifier: LGPL-2.1 */
/*
- * Copyright (C) 2021 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
+ * Copyright 2021 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
*/
#ifndef _TC_KSHARK_PY_UTILS
diff --git a/src/ksharkpy.c b/src/ksharkpy.c
index 7cfb94b..af49c86 100644
--- a/src/ksharkpy.c
+++ b/src/ksharkpy.c
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: LGPL-2.1
/*
- * Copyright (C) 2019 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+ * Copyright 2019 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
*/
/** Use GNU C Library. */
diff --git a/tests/0_get_data/test_get_data.py b/tests/0_get_data/test_get_data.py
index 53decd0..008641e 100755
--- a/tests/0_get_data/test_get_data.py
+++ b/tests/0_get_data/test_get_data.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: LGPL-2.1
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import os
diff --git a/tests/1_unit/test_01_ftracepy_unit.py b/tests/1_unit/test_01_ftracepy_unit.py
index 3411b3f..971fd5f 100644
--- a/tests/1_unit/test_01_ftracepy_unit.py
+++ b/tests/1_unit/test_01_ftracepy_unit.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: LGPL-2.1
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import os
diff --git a/tests/1_unit/test_02_datawrapper_unit.py b/tests/1_unit/test_02_datawrapper_unit.py
index 58c8706..0272d3c 100755
--- a/tests/1_unit/test_02_datawrapper_unit.py
+++ b/tests/1_unit/test_02_datawrapper_unit.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: LGPL-2.1
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import os
diff --git a/tests/1_unit/test_03_ksharkpy_unit.py b/tests/1_unit/test_03_ksharkpy_unit.py
index c7da2a1..20e3cf5 100755
--- a/tests/1_unit/test_03_ksharkpy_unit.py
+++ b/tests/1_unit/test_03_ksharkpy_unit.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: LGPL-2.1
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import os
diff --git a/tests/2_integration/test_01_ftracepy_integration.py b/tests/2_integration/test_01_ftracepy_integration.py
index 824decd..1db5f0b 100755
--- a/tests/2_integration/test_01_ftracepy_integration.py
+++ b/tests/2_integration/test_01_ftracepy_integration.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: LGPL-2.1
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import os
diff --git a/tests/2_integration/test_03_ksharkpy_integration.py b/tests/2_integration/test_03_ksharkpy_integration.py
index dd8e0b5..7515342 100755
--- a/tests/2_integration/test_03_ksharkpy_integration.py
+++ b/tests/2_integration/test_03_ksharkpy_integration.py
@@ -3,7 +3,7 @@
"""
SPDX-License-Identifier: LGPL-2.1
-Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
+Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
"""
import os
--
2.30.2
^ permalink raw reply related [flat|nested] 3+ messages in thread