From 6e2b31ab0ec22c04f8987b4eb54d6ba7bbdee4c4 Mon Sep 17 00:00:00 2001
From: Jim Fehrle
Date: Wed, 23 Dec 2020 16:38:31 -0800
Subject: Set the locale in Docker so Python's default output encoding is utf-8

---
 doc/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'doc/README.md')

diff --git a/doc/README.md b/doc/README.md
index 79d1e1b756..440b104c16 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -69,6 +69,16 @@ Or if you want to use less disk space:
     apt install texlive-latex-extra texlive-fonts-recommended texlive-xetex \
                 latexmk fonts-freefont-otf
 
+### Setting the locale for Python
+
+Make sure that the locale is configured on your platform so that Python encodes
+printed messages with utf-8 rather than generating runtime exceptions
+for non-ascii characters.  The `.UTF-8` in `export LANG=C.UTF-8` sets UTF-8 encoding.
+The `C` can be replaced with any supported language code.  You can set the default
+for a Docker build with `ENV LANG C.UTF-8`.  (Python may look at other
+environment variables to determine the locale; see the
+[Python documentation](https://docs.python.org/3/library/locale.html#locale.getdefaultlocale)).
+
 Compilation
 -----------
 
-- 
cgit v1.2.3