port: tests: Add sys/wait.h include for FreeBSD

[babeltrace.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index e1983b6d262d81035e0a4c4571238ccd8bd0fe31..d89390ee0b618a3fecc72fe8ac14304a803e1c25 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -1,7 +1,7 @@
 // Render with Asciidoctor
 
 = Babeltrace
 // Render with Asciidoctor
 
 = Babeltrace

-15 October 2019
+13 April 2020

 :btversion: 2.0
 :bt2: Babeltrace{nbsp}2
 
 :btversion: 2.0
 :bt2: Babeltrace{nbsp}2
 


@@ -15,10 +15,10 @@ https://ci.lttng.org/job/babeltrace_master_build[image:https://img.shields.io/je
 https://scan.coverity.com/projects/babeltrace[image:https://img.shields.io/coverity/scan/babeltrace.svg[]]
 
 The **_{bt2}_** project offers a library with a
 https://scan.coverity.com/projects/babeltrace[image:https://img.shields.io/coverity/scan/babeltrace.svg[]]
 
 The **_{bt2}_** project offers a library with a

-https://diamon.org/babeltrace/docs/v{btversion}/libbabeltrace2[C{nbsp}API],
-https://diamon.org/babeltrace/docs/v{btversion}/python/bt2[Python{nbsp}3 bindings],
+https://babeltrace.org/docs/v{btversion}/libbabeltrace2[C{nbsp}API],
+https://babeltrace.org/docs/v{btversion}/python/bt2[Python{nbsp}3 bindings],

 and a
 and a

-https://diamon.org/babeltrace/docs/v{btversion}/man1/babeltrace2.1/[command-line tool]
+https://babeltrace.org/docs/v{btversion}/man1/babeltrace2.1/[command-line tool]

 (CLI) which makes it very easy for mere mortals to view, convert,
 transform, and analyze traces.
 
 (CLI) which makes it very easy for mere mortals to view, convert,
 transform, and analyze traces.
 


@@ -29,15 +29,15 @@ https://lttng.org/[LTTng] and
 https://barectf.org/[barectf]. The {bt2} library and its Python bindings
 can read and write CTF traces.
 
 https://barectf.org/[barectf]. The {bt2} library and its Python bindings
 can read and write CTF traces.
 

-See Babeltrace's https://diamon.org/babeltrace[official website], in
+See Babeltrace's https://babeltrace.org[official website], in

 particular the
 particular the

-https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-intro.7[`**babeltrace2-intro**(7)`]
+https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-intro.7[`**babeltrace2-intro**(7)`]

 manual page, to learn more about the project.
 
 [NOTE]
 .Babeltrace{nbsp}1 vs. {bt2}
 ====
 manual page, to learn more about the project.
 
 [NOTE]
 .Babeltrace{nbsp}1 vs. {bt2}
 ====

-The Babeltrace project exists since 2010. In 2019, {bt2} was
+The Babeltrace project exists since 2010. In 2020, {bt2} was

 released. {bt2} is a complete rewrite of the library, Python
 bindings, and CLI. It is plugin-based and offers much more features and
 potential than Babeltrace{nbsp}1 while showing comparable performance.
 released. {bt2} is a complete rewrite of the library, Python
 bindings, and CLI. It is plugin-based and offers much more features and
 potential than Babeltrace{nbsp}1 while showing comparable performance.


@@ -86,17 +86,11 @@ _**If you need the `bt2` Python bindings**_::
       (Debian/Ubuntu: `python3-dev`; Fedora: `python3-devel`)
     * http://www.swig.org[SWIG]{nbsp}≥{nbsp}3.0
 
       (Debian/Ubuntu: `python3-dev`; Fedora: `python3-devel`)
     * http://www.swig.org[SWIG]{nbsp}≥{nbsp}3.0
 

-_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::
+_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::

     * https://sourceware.org/elfutils/[elfutils]{nbsp}≥{nbsp}0.154
       (Debian/Ubuntu: `libelf-dev` and `libdw-dev`;
       Fedora: `elfutils-devel` and `elfutils-libelf-devel`)
 
     * https://sourceware.org/elfutils/[elfutils]{nbsp}≥{nbsp}0.154
       (Debian/Ubuntu: `libelf-dev` and `libdw-dev`;
       Fedora: `elfutils-devel` and `elfutils-libelf-devel`)
 

-_**If you need the `bt2` Python bindings documentation**_::
-    * Python{nbsp}≥{nbsp}3.4
-      (Debian/Ubuntu/Fedora: `python3`)
-    * https://www.sphinx-doc.org/en/master/[Sphinx]{nbsp}≥{nbsp}1.6.5
-      for Python{nbsp}3 (Debian/Ubuntu/Fedora: `python3-sphinx`)
-

 _**If you need the {bt2}{nbsp}C{nbsp}API HTML documentation**_::
     * http://www.doxygen.nl/[Doxygen]{nbsp}≥{nbsp}1.8.6
 
 _**If you need the {bt2}{nbsp}C{nbsp}API HTML documentation**_::
     * http://www.doxygen.nl/[Doxygen]{nbsp}≥{nbsp}1.8.6
 


@@ -104,6 +98,11 @@ _**If you need the {bt2} manual pages**_::
     * https://www.methods.co.nz/asciidoc/[Asciidoc]{nbsp}≥{nbsp}8.6.8
     * https://pagure.io/xmlto[xmlto]{nbsp}≥{nbsp}0.0.25
 
     * https://www.methods.co.nz/asciidoc/[Asciidoc]{nbsp}≥{nbsp}8.6.8
     * https://pagure.io/xmlto[xmlto]{nbsp}≥{nbsp}0.0.25
 

+_**If you need the `bt2` Python bindings documentation**_::
+    * https://www.sphinx-doc.org/[Sphinx]{nbsp}≥{nbsp}1.3 for
+      Python{nbsp}3
+      (Debian/Ubuntu/Fedora: `python3-sphinx`)
+

 
 === Procedure
 
 
 === Procedure
 


@@ -134,7 +133,7 @@ The following options can modify the build:
 `--enable-debug-info`::
     Build the https://lttng.org/[LTTng] debug information filter
     component class
 `--enable-debug-info`::
     Build the https://lttng.org/[LTTng] debug information filter
     component class

-    (https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`]).
+    (https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`]).

 
 `--enable-man-pages`::
     Build the {bt2} manual pages.
 
 `--enable-man-pages`::
     Build the {bt2} manual pages.


@@ -234,13 +233,13 @@ $ BABELTRACE_DEV_MODE=1 BABELTRACE_MINIMAL_LOG_LEVEL=TRACE ./configure \
 ----
 
 See the
 ----
 
 See the

-https://diamon.org/babeltrace/docs/v{btversion}/libbabeltrace2[{bt2}{nbsp}C{nbsp}API]
+https://babeltrace.org/docs/v{btversion}/libbabeltrace2[{bt2}{nbsp}C{nbsp}API]

 documentation for more information.
 
 
 == Use Babeltrace{nbsp}{btversion}
 
 documentation for more information.
 
 
 == Use Babeltrace{nbsp}{btversion}
 

-See the https://diamon.org/babeltrace[Babeltrace website] to learn how
+See the https://babeltrace.org[Babeltrace website] to learn how

 to use the different parts of the project.
 
 
 to use the different parts of the project.
 
 


@@ -257,7 +256,7 @@ _**If you need the `bt2` Python bindings**_::
     * https://www.python.org[Python]{nbsp}≥{nbsp}3.4
       (Debian/Ubuntu/Fedora: `python3`)
 
     * https://www.python.org[Python]{nbsp}≥{nbsp}3.4
       (Debian/Ubuntu/Fedora: `python3`)
 

-_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::
+_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::

     * https://sourceware.org/elfutils/[elfutils]{nbsp}≥{nbsp}0.154
       (Debian/Ubuntu: `libelf` and `libdw`; Fedora: `elfutils-libs` and
       `elfutils-libelf`)
     * https://sourceware.org/elfutils/[elfutils]{nbsp}≥{nbsp}0.154
       (Debian/Ubuntu: `libelf` and `libdw`; Fedora: `elfutils-libs` and
       `elfutils-libelf`)


@@ -270,7 +269,7 @@ _**If you need the https://lttng.org/[LTTng] debug information filter component
 Babeltrace was born to parse CTF traces produced by LTTng{nbsp}2.0 and
 pretty-print their events.
 
 Babeltrace was born to parse CTF traces produced by LTTng{nbsp}2.0 and
 pretty-print their events.
 

-Even though Babeltrace is independant from the LTTng project today,
+Even though Babeltrace is independent from the LTTng project today,

 their communities remain very close, which is why they share some
 communication channels and services.
 ====
 their communities remain very close, which is why they share some
 communication channels and services.
 ====