| Message ID | 20220610225554.5275-1-june.knauth@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | trace-cruncher: README updates; add Testing, reformat, and fix deps | expand |
On Sat, Jun 11, 2022 at 2:07 AM June Knauth <june.knauth@gmail.com> wrote: > > 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 Hi June, "Testing" is described in the CONTRIBUTING file, as it is more related to the development process, but I agree that it is useful to have it in the README as well. Applied. Thanks for polishing the documentation! > > 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 >
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