aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSander Sweers <infirit@gmail.com>2018-05-27 22:33:15 +0200
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-06-09 18:17:48 +0000
commitec616c2aa5584d116116713f5b0286e428bb9b45 (patch)
tree9a0a285847ee708c679a3b8f2129195d448472ea /docs
parent461cf0cba147907a21a8942c8df3deb09d321723 (diff)
downloadmeson-ec616c2aa5584d116116713f5b0286e428bb9b45.zip
meson-ec616c2aa5584d116116713f5b0286e428bb9b45.tar.gz
meson-ec616c2aa5584d116116713f5b0286e428bb9b45.tar.bz2
configure_file: Add release snippet for encoding keyword
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/configure_file_encoding.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/markdown/snippets/configure_file_encoding.md b/docs/markdown/snippets/configure_file_encoding.md
new file mode 100644
index 0000000..8082177
--- /dev/null
+++ b/docs/markdown/snippets/configure_file_encoding.md
@@ -0,0 +1,12 @@
+## New encoding keyword for configure_file
+
+Add a new keyword to [`configure_file()`](#Reference-manual.md#configure_file)
+that allows the developer to specify the input and output file encoding.
+
+If the file encoding of the input is not UTF-8 meson can crash (see #1542).
+A crash as with UTF-16 is the best case and the worst meson will silently
+corrupt the output file for example with ISO-2022-JP. For additional details
+see pull request #3135.
+
+The new keyword defaults to UTF-8 and the documentation strongly suggest to
+convert the file to UTF-8 when possible.