summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/classes.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 63c756e78e..bc7ccb8b71 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2704,6 +2704,25 @@ The :ref:`ref-classes-recipe_sanity` class checks for the presence of any host s
2704recipe prerequisites that might affect the build (e.g. variables that 2704recipe prerequisites that might affect the build (e.g. variables that
2705are set or software that is present). 2705are set or software that is present).
2706 2706
2707.. _ref-classes-relative_symlinks:
2708
2709``relative_symlinks``
2710=====================
2711
2712The :ref:`ref-classes-relative_symlinks` class walks the symbolic links in the
2713:term:`D` directory and replaces links pointing to absolute paths to relative
2714paths. This is occasionally used in some recipes that create wrong symbolic
2715links when their :ref:`ref-classes-native` version is built, and/or would cause
2716breakage in the :ref:`overview-manual/concepts:shared state cache`.
2717
2718For example, if the following symbolic link is found in :term:`D`::
2719
2720 /usr/bin/foo -> /sbin/bar
2721
2722It is replaced by::
2723
2724 /usr/bin/foo -> ../../sbin/bar
2725
2707.. _ref-classes-relocatable: 2726.. _ref-classes-relocatable:
2708 2727
2709``relocatable`` 2728``relocatable``