diff --git a/doc/conf.py b/doc/conf.py index 99e08c1067a239eacb893c2054d0a3b8151d0171..34ae2b9194dd461f3992310671715258b28e3768 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -411,6 +411,10 @@ ignored_refs = { r'docutils\.parsers.*', r'ipywidgets.*', + # TODO: revisit depending on outcome of: + # https://github.com/matplotlib/matplotlib/issues/22601 + r'matplotlib.*', + # Since trappy is not always installed, just hardcode the references we # have since there wont be more in the future. r'trappy.*', diff --git a/doc/setup.rst b/doc/setup.rst index 1de01a34202b5e1591195cc77b67b740edf18a09..633a6bb1ec74ed1e9fe1df237e9cc6e6ef600142 100644 --- a/doc/setup.rst +++ b/doc/setup.rst @@ -160,7 +160,7 @@ them. To help expose these tracepoints (and any additional one we might require in the future) as trace events, an external module is required and is provided -under the name of sched_tp in $LISA_HOME/lisa/_assets/kmodules/sched_tp +under the name of sched_tp in $LISA_HOME/tools/kmodules/sched_tp Building a module ----------------- @@ -210,18 +210,24 @@ Build .. code-block:: sh - $LISA_HOME/lisa/_assets/kmodules/build_module path/to/kernel path/to/kmodule [path/to/install/modules] + $LISA_HOME/tools/kmodules/build_module path/to/kernel path/to/kmodule [path/to/install/modules] This will build the module against the provided kernel tree and install it in ``path/to/install/module`` if provided otherwise install it in ``$LISA_HOME/tools/kmodules``. +.. warning:: The documentation used to refer to + ``$LISA_HOME/lisa/_assets/kmodules`` rather than + ``tools/kmodules``. This was an oversight, DO NOT build from + ``lisa/_assets``. If you still do, any remaining build artifact + could be reused in fresh builds, leading to segfaults and such. + Clean ..... .. code-block:: sh - $LISA_HOME/lisa/_assets/kmodules/clean_module path/to/kernel path/to/kmodule + $LISA_HOME/tools/kmodules/clean_module path/to/kernel path/to/kmodule Highly recommended to clean when switching kernel trees to avoid unintentional breakage for using stale binaries. diff --git a/tools/kmodules b/tools/kmodules deleted file mode 120000 index fe5e7658698e0f8135e7f2eac41c6509ada228fc..0000000000000000000000000000000000000000 --- a/tools/kmodules +++ /dev/null @@ -1 +0,0 @@ -../lisa/_assets/kmodules \ No newline at end of file diff --git a/tools/kmodules/build_module b/tools/kmodules/build_module new file mode 120000 index 0000000000000000000000000000000000000000..6bec5562acc3eb4fcf3b59cf0933a4362b65219c --- /dev/null +++ b/tools/kmodules/build_module @@ -0,0 +1 @@ +../../lisa/_assets/kmodules/build_module \ No newline at end of file diff --git a/tools/kmodules/sched_tp/Makefile b/tools/kmodules/sched_tp/Makefile new file mode 120000 index 0000000000000000000000000000000000000000..24d87113127cd838588cc1ff73b2f0a4dc0af9a7 --- /dev/null +++ b/tools/kmodules/sched_tp/Makefile @@ -0,0 +1 @@ +../../../lisa/_assets/kmodules/sched_tp/Makefile \ No newline at end of file diff --git a/tools/kmodules/sched_tp/private_types.txt b/tools/kmodules/sched_tp/private_types.txt new file mode 120000 index 0000000000000000000000000000000000000000..c029dfee8ced2606eecf533fd7877b7255e7a85a --- /dev/null +++ b/tools/kmodules/sched_tp/private_types.txt @@ -0,0 +1 @@ +../../../lisa/_assets/kmodules/sched_tp/private_types.txt \ No newline at end of file diff --git a/tools/kmodules/sched_tp/sched_events.h b/tools/kmodules/sched_tp/sched_events.h new file mode 120000 index 0000000000000000000000000000000000000000..2684da41c5ae82d20cf407be9b925033f4538d8c --- /dev/null +++ b/tools/kmodules/sched_tp/sched_events.h @@ -0,0 +1 @@ +../../../lisa/_assets/kmodules/sched_tp/sched_events.h \ No newline at end of file diff --git a/tools/kmodules/sched_tp/sched_tp.c b/tools/kmodules/sched_tp/sched_tp.c new file mode 120000 index 0000000000000000000000000000000000000000..2f34f2c5c6b006c4ff16d9799d0bce6b4b91e60d --- /dev/null +++ b/tools/kmodules/sched_tp/sched_tp.c @@ -0,0 +1 @@ +../../../lisa/_assets/kmodules/sched_tp/sched_tp.c \ No newline at end of file diff --git a/tools/kmodules/sched_tp/sched_tp_helpers.h b/tools/kmodules/sched_tp/sched_tp_helpers.h new file mode 120000 index 0000000000000000000000000000000000000000..49303803d5bcd3db9e66dd447fc918eea2a66664 --- /dev/null +++ b/tools/kmodules/sched_tp/sched_tp_helpers.h @@ -0,0 +1 @@ +../../../lisa/_assets/kmodules/sched_tp/sched_tp_helpers.h \ No newline at end of file