summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-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 0e616420cf..2a69d2d59b 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2498,6 +2498,25 @@ The :ref:`ref-classes-recipe_sanity` class checks for the presence of any host s
2498recipe prerequisites that might affect the build (e.g. variables that 2498recipe prerequisites that might affect the build (e.g. variables that
2499are set or software that is present). 2499are set or software that is present).
2500 2500
2501.. _ref-classes-relative_symlinks:
2502
2503``relative_symlinks``
2504=====================
2505
2506The :ref:`ref-classes-relative_symlinks` class walks the symbolic links in the
2507:term:`D` directory and replaces links pointing to absolute paths to relative
2508paths. This is occasionally used in some recipes that create wrong symbolic
2509links when their :ref:`ref-classes-native` version is built, and/or would cause
2510breakage in the :ref:`overview-manual/concepts:shared state cache`.
2511
2512For example, if the following symbolic link is found in :term:`D`::
2513
2514 /usr/bin/foo -> /sbin/bar
2515
2516It is replaced by::
2517
2518 /usr/bin/foo -> ../../sbin/bar
2519
2501.. _ref-classes-relocatable: 2520.. _ref-classes-relocatable:
2502 2521
2503``relocatable`` 2522``relocatable``