sessiond: introduce cleared_after_last_stop

[lttng-tools.git] / README.md

diff --git a/README.md b/README.md
index 0a03fea5b6ec395bc308751c2b4b60281af950c4..92df20daf48c94d410c56ebda8580cd1cbb26052 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
 LTTng-tools
 ===========
 
 LTTng-tools
 ===========
 

+[![Jenkins](https://img.shields.io/jenkins/s/https/ci.lttng.org/lttng-tools_master_build.svg)](https://ci.lttng.org/job/lttng-tools_master_build/)
+[![Coverity](https://img.shields.io/coverity/scan/lttng-tools.svg)](https://scan.coverity.com/projects/lttng-tools)
+

 LTTng-tools is a set of tools to control [LTTng](https://lttng.org/)
 LTTng-tools is a set of tools to control [LTTng](https://lttng.org/)

-tracing. The project includes the LTTng session daemon, consumer damon
+tracing. The project includes the LTTng session daemon, consumer daemon

 and relay daemon, as well as `liblttng-ctl`, a C library used to
 communicate with the session daemon, and `lttng`, a command line
 interface to `liblttng-ctl`.
 and relay daemon, as well as `liblttng-ctl`, a C library used to
 communicate with the session daemon, and `lttng`, a command line
 interface to `liblttng-ctl`.


@@ -20,12 +23,10 @@ components:
     that, the kernel version may probably be older, but we can't provide
     any guarantee. Please let us know if you are able to go lower
     without any problems.
     that, the kernel version may probably be older, but we can't provide
     any guarantee. Please let us know if you are able to go lower
     without any problems.

-  - **[`liburcu`](http://www.liburcu.org/) >= 0.8.0**: userspace RCU library,
+  - **[`liburcu`](http://www.liburcu.org/) >= 0.9.0**: userspace RCU library,

     by Mathieu Desnoyers and Paul E. McKenney.
   - **`libpopt` >= 1.13**:  command line arguments parsing library.
     - Debian/Ubuntu package: `libpopt-dev`
     by Mathieu Desnoyers and Paul E. McKenney.
   - **`libpopt` >= 1.13**:  command line arguments parsing library.
     - Debian/Ubuntu package: `libpopt-dev`

-  - **`libuuid`**: universally unique ID library
-    - Debian/Ubuntu package: `uuid-dev`

   - **`libxml2` >= 2.7.6**:  XML document parsing library. Needed for
     tracing session configuration saving/loading and machine interface
     output support.
   - **`libxml2` >= 2.7.6**:  XML document parsing library. Needed for
     tracing session configuration saving/loading and machine interface
     output support.


@@ -49,7 +50,13 @@ The following items are _optional_ dependencies:
     - Debian/Ubuntu packages: `swig2.0` and `python3-dev`
   - **modprobe**: needed for automatic LTTng kernel modules loading
     (kernel tracing).
     - Debian/Ubuntu packages: `swig2.0` and `python3-dev`
   - **modprobe**: needed for automatic LTTng kernel modules loading
     (kernel tracing).

-  - **bash**: needed for running `make check`.
+  - **bash**: needed to run `make check`.
+  - **man** (manual pager): needed to view LTTng-tools commands' man
+    pages with the `--help` option or with the `lttng help` command.
+    Note that without `man`, you cannot get offline help with
+    LTTng-tools commands, not even their usage.
+  - **libpfm >= 4.0**: needed to run the perf regression test suite.
+    - Debian/Ubuntu package: `libpfm4-dev`

 
 LTTng-tools supports both the [LTTng Linux Kernel tracer](https://lttng.org)
 and [LTTng user space tracer](https://lttng.org) released as part of the same
 
 LTTng-tools supports both the [LTTng Linux Kernel tracer](https://lttng.org)
 and [LTTng user space tracer](https://lttng.org) released as part of the same


@@ -71,7 +78,7 @@ order to compile the Git repository tree:
 
   - **GNU Autotools** (**Automake >= 1.10**, **Autoconf >= 2.64**,
     **Autoheader >= 2.50**; make sure your system-wide `automake` points
 
   - **GNU Autotools** (**Automake >= 1.10**, **Autoconf >= 2.64**,
     **Autoheader >= 2.50**; make sure your system-wide `automake` points

-    to a recent version!)
+    to a recent version)

   - **[GNU Libtool](http://www.gnu.org/software/autoconf/) >= 2.2**
   - **Flex >= 2.5.35**
   - **Bison >= 2.4**
   - **[GNU Libtool](http://www.gnu.org/software/autoconf/) >= 2.2**
   - **Flex >= 2.5.35**
   - **Bison >= 2.4**


@@ -150,6 +157,7 @@ This package contains the following elements:
   - `include`: the public header files that will be installed on the system.
   - `src/bin`: source code of LTTng-tools programs.
     - `lttng-consumerd`: consumer daemon.
   - `include`: the public header files that will be installed on the system.
   - `src/bin`: source code of LTTng-tools programs.
     - `lttng-consumerd`: consumer daemon.

+    - `lttng-crash`: crash trace viewer.

     - `lttng-relayd`: relay daemon.
     - `lttng-sessiond`: session daemon.
     - `lttng`: command line interface for LTTng tracing control.
     - `lttng-relayd`: relay daemon.
     - `lttng-sessiond`: session daemon.
     - `lttng`: command line interface for LTTng tracing control.