diff options
| author | Ian Wienand <iwienand@redhat.com> | 2017-11-17 09:31:36 +1100 |
|---|---|---|
| committer | Ian Wienand <iwienand@redhat.com> | 2017-11-17 14:09:10 +1100 |
| commit | 2ee19d3526e50ebc04b77a4f52a9bac23aad2e17 (patch) | |
| tree | fb5c4fc23d59530e777e9c26b238429dc7feab5b | |
| parent | bbea22f773a7c6ab0c7a970aa4cd83ead1a5c495 (diff) | |
| download | git-review-2ee19d3526e50ebc04b77a4f52a9bac23aad2e17.tar.gz | |
Add a note on Windows and Unicode
Add a rough note on what we've discovered about Windows and Unicode.
tl;dr use Python 3.6+
Change-Id: I219cfca6cb9ad427a55a7a1821f9fe0a9cf632f3
| -rw-r--r-- | doc/source/installation.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/installation.rst b/doc/source/installation.rst index c36891c..fa7cc4c 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -18,6 +18,16 @@ after installing the dependencies listed in requirements.txt .. note:: ``git-review`` requires git version 1.8 or greater. +Windows +------- + +The Windows ``cmd`` console has a number of issues with Python and +Unicode encodings which can manifest when reviews include non-ASCII +characters. Python 3.6 and beyond has addressed most issues and is +recommended for Windows users. For earlier Python versions, +modifying the local install with `win-unicode-console +<https://github.com/Drekin/win-unicode-console>`__ may also help. + Setup ===== |