diff options
| author | Zubin Duggal <zubin.duggal@gmail.com> | 2021-10-04 16:19:37 +0530 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2021-10-05 14:35:52 -0400 |
| commit | 29ee04f330514651537b0e851a948373a38fa231 (patch) | |
| tree | 30b38cea7fe9a9bda655321099558681cf171d48 | |
| parent | 11240b7427c54c3233aa3cce5adc3a5209df8031 (diff) | |
| download | haskell-29ee04f330514651537b0e851a948373a38fa231.tar.gz | |
docs: Clarify documentation of `getFileSystemEncoding` (#20344)
It may not always be a Unicode encoding
| -rw-r--r-- | libraries/base/GHC/IO/Encoding.hs | 4 |
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. -- |