trace-cruncher: Update CONTRIBUTING.md
PATCH 1/3 trace-cruncher: Update CONTRIBUTING.md
Remove the legacy content that came from the template file and make it provide adequate instruction for contributors.
Signed-off-by Yordan Karadzhov (VMware) <[email protected]>
--- CONTRIBUTING.md | 72 +++++++------------------------------------------ 1 file changed, 10 insertions(+), 62 deletions(-)
CONTRIBUTING.md +10 -62
@@ -2,77 +2,25 @@ # Contributing to trace-cruncher -The trace-cruncher project team welcomes contributions from the community. Before you start working with trace-cruncher, please -read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be -signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on -as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md). +The trace-cruncher project team welcomes contributions from the community. All contributions to this repository must be +signed. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. -## Contribution Flow +The development process of trace-cruncher is strongly coupled to the development of the Linux kernel tracing libraries [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/). Because of this reason we adopt and follow the development workflow established by those projects. -This is a rough outline of what a contributor's workflow looks like: +For contributions to development, please send patches to: [email protected] -- Create a topic branch from where you want to base your work -- Make commits of logical units -- Make sure your commit messages are in the proper format (see below) -- Push your changes to a topic branch in your fork of the repository -- Submit a pull request - -Example: - -``` shell -git remote add upstream https://github.com/vmware/trace-cruncher.git -git checkout -b my-new-feature master -git commit -a -git push origin my-new-feature -``` - -### Staying In Sync With Upstream - -When your branch gets out of sync with the vmware/master branch, use the following to update: - -``` shell -git checkout my-new-feature -git fetch -a -git pull --rebase upstream master -git push --force-with-lease origin my-new-feature -``` - -### Updating pull requests - -If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into -existing commits. - -If your pull request contains a single commit or your changes are related to the most recent commit, you can simply -amend the commit. - -``` shell -git add . -git commit --amend -git push --force-with-lease origin my-new-feature -``` - -If you need to squash changes into an earlier commit, you can use: - -``` shell -git add . -git commit --fixup <commit> -git rebase -i --autosquash master -git push --force-with-lease origin my-new-feature -``` - -Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a -notification when you git push. +[Subscribe](http://vger.kernel.org/vger-lists.html#linux-trace-devel) / [Archives](https://lore.kernel.org/linux-trace-devel/) ### Code Style -### Formatting Commit Messages +The preferred coding style for the project is the [Linux kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#linux-kernel-coding-style) -We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/). +### Formatting Commit Messages -Be sure to include any related GitHub issue references in the commit message. See -[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues -and commits. +The project follows the conventions for [submitting patches](https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html) +as described by the Linux kernel. ## Reporting Bugs and Creating Issues +For bug reports and issues, please file it [bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---) When opening a new issue, try to roughly follow the commit message format conventions above.
Signature · 1 line
2.30.2
PATCH 2/3 trace-cruncher: Update README.md
Improve the the description of the project and make the provided information consistent with content of CONTRIBUTING.md.
Signed-off-by Yordan Karadzhov (VMware) <[email protected]>
--- README.md | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-)
README.md +13 -18
@@ -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: [email protected] -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
Signature · 1 line
2.30.2
PATCH 3/3 trace-cruncher: Fix the copyright notices
In reply to Yordan Karadzhov (VMware)Using '(C)' in the text of the copyright notice is no longer required.
Signed-off-by Yordan Karadzhov (VMware) <[email protected]>
--- 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(-)
examples/kprobe_open.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: CC-BY-4.0 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import sys
examples/start_tracing.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: CC-BY-4.0 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import tracecruncher.ftracepy as ft
src/common.h +1 -1
@@ -1,7 +1,7 @@/* SPDX-License-Identifier: LGPL-2.1 */ /* -* Copyright (C) 2017 VMware Inc, Yordan Karadzhov <[email protected]> +* Copyright 2017 VMware Inc, Yordan Karadzhov <[email protected]> */ #ifndef _TC_COMMON_H
src/ftracepy-utils.c +1 -1
@@ -1,7 +1,7 @@// SPDX-License-Identifier: LGPL-2.1 /* -* Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +* Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> */ #ifndef _GNU_SOURCE
src/ftracepy-utils.h +1 -1
@@ -1,7 +1,7 @@/* SPDX-License-Identifier: LGPL-2.1 */ /* -* Copyright (C) 2021 VMware Inc, Yordan Karadzhov <[email protected]> +* Copyright 2021 VMware Inc, Yordan Karadzhov <[email protected]> */ #ifndef _TC_FTRACE_PY_UTILS
src/ftracepy.c +1 -1
@@ -1,7 +1,7 @@// SPDX-License-Identifier: LGPL-2.1 /* -* Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +* Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> */ // trace-cruncher
src/ksharkpy-utils.c +1 -1
@@ -1,7 +1,7 @@// SPDX-License-Identifier: LGPL-2.1 /* -* Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +* Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> */ #ifndef _GNU_SOURCE
src/ksharkpy-utils.h +1 -1
@@ -1,7 +1,7 @@/* SPDX-License-Identifier: LGPL-2.1 */ /* -* Copyright (C) 2021 VMware Inc, Yordan Karadzhov <[email protected]> +* Copyright 2021 VMware Inc, Yordan Karadzhov <[email protected]> */ #ifndef _TC_KSHARK_PY_UTILS
src/ksharkpy.c +1 -1
@@ -1,7 +1,7 @@// SPDX-License-Identifier: LGPL-2.1 /* -* Copyright (C) 2019 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +* Copyright 2019 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> */ /** Use GNU C Library. */
tests/0_get_data/test_get_data.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: LGPL-2.1 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import os
tests/1_unit/test_01_ftracepy_unit.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: LGPL-2.1 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import os
tests/1_unit/test_02_datawrapper_unit.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: LGPL-2.1 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import os
tests/1_unit/test_03_ksharkpy_unit.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: LGPL-2.1 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import os
tests/2_integration/test_01_ftracepy_integration.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: LGPL-2.1 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import os
tests/2_integration/test_03_ksharkpy_integration.py +1 -1
@@ -3,7 +3,7 @@ """ SPDX-License-Identifier: LGPL-2.1 -Copyright (C) 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> +Copyright 2021 VMware Inc, Yordan Karadzhov (VMware) <[email protected]> """ import os
Signature · 1 line
2.30.2