Remove fixme, add Python bug documentation ENGINE-237
authorDamiano Boppart <damiano@pep-security.net>
Tue, 29 Aug 2017 16:40:43 +0200
branchENGINE-237
changeset 20196c2b325f2056
parent 2018 479c39e0c729
child 2023 ba30fa883329
Remove fixme, add Python bug documentation
doc/build-macos.md
     1.1 --- a/doc/build-macos.md	Tue Aug 29 16:11:21 2017 +0200
     1.2 +++ b/doc/build-macos.md	Tue Aug 29 16:40:43 2017 +0200
     1.3 @@ -26,9 +26,6 @@
     1.4  sudo port install gpgme
     1.5  ~~~
     1.6  
     1.7 -FIXME Are `zlib openssl cyrus-sasl2` needed?
     1.8 -They were present in an older revision of the build instructions.
     1.9 -
    1.10  Ensure that `python` is Python 2.7:
    1.11  
    1.12  ~~~
    1.13 @@ -110,6 +107,18 @@
    1.14  make db
    1.15  ~~~
    1.16  
    1.17 +If your build fails with an error message similar to the following:
    1.18 +
    1.19 +~~~
    1.20 +  File "/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/locale.py", line 477, in _parse_localename
    1.21 +    raise ValueError, 'unknown locale: %s' % localename
    1.22 +ValueError: unknown locale: UTF-8
    1.23 +~~~
    1.24 +
    1.25 +or any other locale-related Python error, make sure Python does not have any locale-related environment variables set.
    1.26 +Usually, `unset LC_CTYPE` is sufficient to take care of the problem, but it depends on your macOS's regional and language settings and which terminal emulator you use.
    1.27 +This is a bug in Python, see [https://bugs.python.org/issue18378#msg215215](https://bugs.python.org/issue18378#msg215215).
    1.28 +
    1.29  The unit tests can be run without the engine library being installed, however `system.db` must be installed:
    1.30  
    1.31  ~~~