summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--libraries/base/GHC/IO/Encoding.hs4
1 files changed, 3 insertions, 1 deletions
diff --git a/libraries/base/GHC/IO/Encoding.hs b/libraries/base/GHC/IO/Encoding.hs
index 9bad2c6b58..0238f1b348 100644
--- a/libraries/base/GHC/IO/Encoding.hs
+++ b/libraries/base/GHC/IO/Encoding.hs
@@ -109,9 +109,11 @@ utf32be = UTF32.utf32be
getLocaleEncoding :: IO TextEncoding
{-# NOINLINE getLocaleEncoding #-}
--- | The Unicode encoding of the current locale, but allowing arbitrary
+-- | The encoding of the current locale, but allowing arbitrary
-- undecodable bytes to be round-tripped through it.
--
+-- Do not expect the encoding to be Unicode-compatible: it could appear to be ASCII or anything else.
+--
-- This 'TextEncoding' is used to decode and encode command line arguments
-- and environment variables on non-Windows platforms.
--