aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSander Sweers <infirit@gmail.com>2018-02-25 12:26:33 +0100
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-06-09 18:17:48 +0000
commit38fa281448b7729a6c68f9aeeeafd7c539caf507 (patch)
tree8b31c9071b4017588fcefba9ca08d82d2cbc81f4 /docs
parent47785bf89b56bd111080d8a26d9f8bca9bb4d25c (diff)
downloadmeson-38fa281448b7729a6c68f9aeeeafd7c539caf507.zip
meson-38fa281448b7729a6c68f9aeeeafd7c539caf507.tar.gz
meson-38fa281448b7729a6c68f9aeeeafd7c539caf507.tar.bz2
Add new encoding keyword for configure_file to manual
Also add a section how to deal with file encodings.
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Configuration.md8
-rw-r--r--docs/markdown/Reference-manual.md3
2 files changed, 11 insertions, 0 deletions
diff --git a/docs/markdown/Configuration.md b/docs/markdown/Configuration.md
index 89f423c..8b79bc6 100644
--- a/docs/markdown/Configuration.md
+++ b/docs/markdown/Configuration.md
@@ -113,6 +113,14 @@ Will produce:
#define BAR
```
+## Dealing with file encodings
+
+The default meson file encoding to configure files is utf-8. If you need to
+configure a file that is not utf-8 encoded the encoding keyword will allow
+you to specify which file encoding to use. It is however strongly advised to
+convert your non utf-8 file to utf-8 whenever possible. Supported file
+encodings are those of python3, see [standard-encodings](https://docs.python.org/3/library/codecs.html#standard-encodings).
+
# A full example
Generating and using a configuration file requires the following steps:
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index cc49e88..4d48c5f 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -214,6 +214,9 @@ the `@variable@` syntax.
was specified. It defaults to `c`, in which case preprocessor directives
will be prefixed with `#`, you can also use `nasm`, in which case the
prefix will be `%`.
+- `encoding` *(added v0.47.0)* set the file encoding for the input and output file,
+ defaults to utf-8. The supported encodings are those of python3, see
+ [standard-encodings](https://docs.python.org/3/library/codecs.html#standard-encodings).
### custom_target()