aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/snippets
diff options
context:
space:
mode:
Diffstat (limited to 'docs/markdown/snippets')
-rw-r--r--docs/markdown/snippets/install_symlink.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/markdown/snippets/install_symlink.md b/docs/markdown/snippets/install_symlink.md
new file mode 100644
index 0000000..752c422
--- /dev/null
+++ b/docs/markdown/snippets/install_symlink.md
@@ -0,0 +1,11 @@
+## install_symlink function
+
+It is now possible to request for symbolic links to be installed during
+installation. The `install_symlink` function takes a positional argument to
+the link name, and installs a symbolic link pointing to `pointing_to` target.
+The link will be created under `install_dir` directory and cannot contain path
+separators.
+
+```meson
+install_symlink('target', pointing_to: '../bin/target', install_dir: '/usr/sbin')
+```