aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorArsen Arsenović <arsen@aarsen.me>2022-07-12 15:26:22 +0200
committerEli Schwartz <eschwartz93@gmail.com>2023-09-13 21:44:40 -0400
commit0af126fec798d6dbb0d1ad52168cc1f3f1758acd (patch)
tree41e4a51789de1e92881b29e7a7d9f13e5f369f8f /docs
parent56ef698426bb58b7ffd32b0711e064b54166e10f (diff)
downloadmeson-0af126fec798d6dbb0d1ad52168cc1f3f1758acd.zip
meson-0af126fec798d6dbb0d1ad52168cc1f3f1758acd.tar.gz
meson-0af126fec798d6dbb0d1ad52168cc1f3f1758acd.tar.bz2
install_{data,headers,subdir}: implement follow_symlinks
This permits users who rely on following symlinks to stay on the old default of following them.
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/install_follow_symlink_arg.md7
-rw-r--r--docs/yaml/functions/install_data.yaml8
-rw-r--r--docs/yaml/functions/install_headers.yaml8
-rw-r--r--docs/yaml/functions/install_subdir.yaml8
4 files changed, 31 insertions, 0 deletions
diff --git a/docs/markdown/snippets/install_follow_symlink_arg.md b/docs/markdown/snippets/install_follow_symlink_arg.md
new file mode 100644
index 0000000..ce971d7
--- /dev/null
+++ b/docs/markdown/snippets/install_follow_symlink_arg.md
@@ -0,0 +1,7 @@
+## Added follow_symlinks arg to install_data, install_header, and install_subdir
+
+The [[install_data]], [[install_headers]], [[install_subdir]] functions now
+have an optional argument `follow_symlinks` that, if set to `true`, makes it so
+symbolic links in the source are followed, rather than copied into the
+destination tree, to match the old behavior. The default, which is currently
+to follow links, is subject to change in the future.
diff --git a/docs/yaml/functions/install_data.yaml b/docs/yaml/functions/install_data.yaml
index 5ecc318..ff4f336 100644
--- a/docs/yaml/functions/install_data.yaml
+++ b/docs/yaml/functions/install_data.yaml
@@ -69,3 +69,11 @@ kwargs:
sources:
type: list[file | str]
description: Additional files to install.
+
+ follow_symlinks:
+ type: bool
+ since: 1.3.0
+ default: true
+ description: |
+ If true, dereferences links and copies their target instead. The default
+ value will become false in the future.
diff --git a/docs/yaml/functions/install_headers.yaml b/docs/yaml/functions/install_headers.yaml
index 958ab15..0ac4fc5 100644
--- a/docs/yaml/functions/install_headers.yaml
+++ b/docs/yaml/functions/install_headers.yaml
@@ -73,3 +73,11 @@ kwargs:
Disable stripping child-directories from header files when installing.
This is equivalent to GNU Automake's `nobase` option.
+
+ follow_symlinks:
+ type: bool
+ since: 1.3.0
+ default: true
+ description: |
+ If true, dereferences links and copies their target instead. The default
+ value will become false in the future.
diff --git a/docs/yaml/functions/install_subdir.yaml b/docs/yaml/functions/install_subdir.yaml
index 1907cec..19abee3 100644
--- a/docs/yaml/functions/install_subdir.yaml
+++ b/docs/yaml/functions/install_subdir.yaml
@@ -106,3 +106,11 @@ kwargs:
description: |
Install directory contents.
If `strip_directory=true` only the last component of the source path is used.
+
+ follow_symlinks:
+ type: bool
+ since: 1.3.0
+ default: true
+ description: |
+ If true, dereferences links and copies their target instead. The default
+ value will become false in the future.