* [PATCH v2] trace-cruncher: Update CONTRIBUTING doc with tests
@ 2022-01-27 15:04 Tzvetomir Stoyanov (VMware)
0 siblings, 0 replies; only message in thread
From: Tzvetomir Stoyanov (VMware) @ 2022-01-27 15:04 UTC (permalink / raw)
To: y.karadz; +Cc: linux-trace-devel
All trace-cruncher code should be covered by the unit tests. Added
instructions how to run the tests in CONTRIBUTING document.
Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
CONTRIBUTING.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1f73807..0eb9f85 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -20,6 +20,15 @@ The preferred coding style for the project is the [Linux kernel coding style](ht
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.
+### Tests
+
+Make sure that all your changes are covered by the tests. Before submitting your patch, check if everything works at 100% by running the tests in **tracecruncher/tests**. Compile your changes and install trace-cruncher (`sudo make install`), to make sure that your code is used in the tests. As trace-cruncher interacts with the Linux kernel tracing infrastructure, the tests must be run with root privileges:
+
+``` shell
+cd tracecruncher/tests
+sudo python3 -m unittest discover .
+```
+
## 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=---)
--
2.34.1
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2022-01-27 15:04 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-01-27 15:04 [PATCH v2] trace-cruncher: Update CONTRIBUTING doc with tests Tzvetomir Stoyanov (VMware)
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).