2.12: update installation

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/2.12/lttng-docs-2.12.txt b/2.12/lttng-docs-2.12.txt
index 7d8311fadde28c53f8c5e82573c78ff732b5e646..d80ba3057249f04637d3311265deb8c29d5ee8b8 100644 (file)
--- a/2.12/lttng-docs-2.12.txt
+++ b/2.12/lttng-docs-2.12.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.12, 14 January 2021
+v2.12, 25 February 2021
 
 
 include::../common/copyright.txt[]
@@ -399,29 +399,85 @@ but note that:
   applications.
 
 [role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 5{nbsp}August{nbsp}2020.
+.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 25{nbsp}February{nbsp}2021.
 |====
 |Distribution |Available in releases
 
 |https://www.ubuntu.com/[Ubuntu]
-|Ubuntu{nbsp}16.04 _Xenial Xerus_, Ubuntu{nbsp}18.04 _Bionic Beaver_,
+|<<ubuntu,Ubuntu 20.10 _Groovy Gorilla_>>.
+
+Ubuntu{nbsp}16.04 _Xenial Xerus_, Ubuntu{nbsp}18.04 _Bionic Beaver_,
 and Ubuntu{nbsp}20.04 _Focal Fossa_:
 <<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
 
 |https://www.debian.org/[Debian]
 |<<debian,Debian "bullseye" (testing)>>.
 
+|https://getfedora.org/[Fedora]
+|xref:fedora[Fedora{nbsp}33, Fedora{nbsp}34, and Fedora{nbsp}35].
+
 |https://www.archlinux.org/[Arch Linux]
 |<<arch-linux,_Community_ repository and AUR>>.
 
-|https://alpinelinux.org/[Alpine Linux]
-|<<alpine-linux,Alpine Linux{nbsp}3.12>>.
-
 |https://www.redhat.com/[RHEL] and https://www.suse.com/[SLES]
 |See http://packages.efficios.com/[EfficiOS Enterprise Packages].
+
+|https://alpinelinux.org/[Alpine Linux]
+|<<alpine-linux,Alpine Linux{nbsp}3.12 and Alpine Linux{nbsp}3.13>>.
+
+|https://buildroot.org/[Buildroot]
+|xref:buildroot[Buildroot{nbsp}2020.08 and Buildroot{nbsp}2020.11].
+
+|https://www.openembedded.org/wiki/Main_Page[OpenEmbedded] and
+https://www.yoctoproject.org/[Yocto]
+|<<oe-yocto,Yocto Project{nbsp}3.2 _Gatesgarth_>>
+(`openembedded-core` layer).
 |====
 
 
+[[ubuntu]]
+=== [[ubuntu-official-repositories]]Ubuntu
+
+LTTng{nbsp}{revision} is available on Ubuntu{nbsp}20.10 _Groovy
+Gorilla_. For previous supported releases of Ubuntu, <<ubuntu-ppa,use
+the LTTng Stable{nbsp}{revision} PPA>>.
+
+To install LTTng{nbsp}{revision} on Ubuntu{nbsp}20.10 _Groovy Gorilla_:
+
+. Install the main LTTng{nbsp}{revision} packages:
++
+--
+[role="term"]
+----
+# apt-get install lttng-tools
+# apt-get install lttng-modules-dkms
+# apt-get install liblttng-ust-dev
+----
+--
+
+. **If you need to instrument and trace
+  <<java-application,Java applications>>**, install the LTTng-UST
+  Java agent:
++
+--
+[role="term"]
+----
+# apt-get install liblttng-ust-agent-java
+----
+--
+
+. **If you need to instrument and trace
+  <<python-application,Python{nbsp}3 applications>>**, install the
+  LTTng-UST Python agent:
++
+--
+[role="term"]
+----
+# apt-get install python3-lttngust
+----
+--
+
+
 [[ubuntu-ppa]]
 === Ubuntu: noch:{LTTng} Stable {revision} PPA
 
@@ -515,6 +571,55 @@ To install LTTng{nbsp}{revision} on Debian "bullseye" (testing):
 --
 
 
+[[fedora]]
+=== Fedora
+
+To install LTTng{nbsp}{revision} on Fedora{nbsp}33, Fedora{nbsp}34, or
+Fedora{nbsp}35:
+
+. Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision}
+  packages:
++
+--
+[role="term"]
+----
+# yum install lttng-tools
+# yum install lttng-ust
+----
+--
+
+. Download, build, and install the latest LTTng-modules{nbsp}{revision}:
++
+--
+[role="term"]
+----
+$ cd $(mktemp -d) &&
+wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.12.tar.bz2 &&
+tar -xf lttng-modules-latest-2.12.tar.bz2 &&
+cd lttng-modules-2.12.* &&
+make &&
+sudo make modules_install &&
+sudo depmod -a
+----
+--
+
+[IMPORTANT]
+.Java and Python application instrumentation and tracing
+====
+If you need to instrument and trace <<java-application,Java
+applications>> on Fedora, you need to build and install
+LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
+the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
+`--enable-java-agent-all` options to the `configure` script, depending
+on which Java logging framework you use.
+
+If you need to instrument and trace <<python-application,Python
+applications>> on Fedora, you need to build and install
+LTTng-UST{nbsp}{revision} from source and pass the
+`--enable-python-agent` option to the `configure` script.
+====
+
+
 [[arch-linux]]
 === Arch Linux
 
@@ -553,7 +658,7 @@ $ yay -Sy lttng-modules
 === Alpine Linux
 
 To install LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} on
-Alpine Linux{nbsp}3.12:
+Alpine Linux{nbsp}3.12 or Alpine Linux{nbsp}3.13:
 
 . Add the LTTng packages:
 +
@@ -581,6 +686,55 @@ sudo depmod -a
 --
 
 
+[[buildroot]]
+=== Buildroot
+
+To install LTTng{nbsp}{revision} on Buildroot{nbsp}2020.08 or
+Buildroot{nbsp}2020.11:
+
+. Launch the Buildroot configuration tool:
++
+--
+[role="term"]
+----
+$ make menuconfig
+----
+--
+
+. In **Kernel**, check **Linux kernel**.
+. In **Toolchain**, check **Enable WCHAR support**.
+. In **Target packages**{nbsp}&#8594; **Debugging, profiling and benchmark**,
+  check **lttng-modules** and **lttng-tools**.
+. In **Target packages**{nbsp}&#8594; **Libraries**{nbsp}&#8594;
+  **Other**, check **lttng-libust**.
+
+
+[[oe-yocto]]
+=== OpenEmbedded and Yocto
+
+LTTng{nbsp}{revision} recipes are available in the
+https://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/[`openembedded-core`]
+layer for Yocto Project{nbsp}3.2 _Gatesgarth_ under the following names:
+
+* `lttng-tools`
+* `lttng-modules`
+* `lttng-ust`
+
+With BitBake, the simplest way to include LTTng recipes in your target
+image is to add them to `IMAGE_INSTALL_append` in path:{conf/local.conf}:
+
+----
+IMAGE_INSTALL_append = " lttng-tools lttng-modules lttng-ust"
+----
+
+If you use Hob:
+
+. Select a machine and an image recipe.
+. Click **Edit image recipe**.
+. Under the **All recipes** tab, search for **lttng**.
+. Check the desired LTTng recipes.
+
+
 [[building-from-source]]
 === Build from source