From 38fa281448b7729a6c68f9aeeeafd7c539caf507 Mon Sep 17 00:00:00 2001
From: Sander Sweers <infirit@gmail.com>
Date: Sun, 25 Feb 2018 12:26:33 +0100
Subject: Add new encoding keyword for configure_file to manual

Also add a section how to deal with file encodings.
---
 docs/markdown/Configuration.md    | 8 ++++++++
 docs/markdown/Reference-manual.md | 3 +++
 2 files changed, 11 insertions(+)

(limited to 'docs')

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()
 
-- 
cgit v1.1