[Git][ghc/ghc][master] FastString is a __Modified__ UTF-8

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
0255d03c by Oleg Grenrus at 2024-04-12T08:22:07-04:00
FastString is a __Modified__ UTF-8

- - - - -


3 changed files:

- compiler/GHC/Data/FastString.hs
- libraries/ghc-boot/GHC/Data/ShortText.hs
- libraries/ghc-boot/GHC/Utils/Encoding/UTF8.hs


Changes:

=====================================
compiler/GHC/Data/FastString.hs
=====================================
@@ -198,8 +198,8 @@ mkFastZStringString str = FastZString (BSC.pack str)
 
 -- -----------------------------------------------------------------------------
 
-{-| A 'FastString' is a UTF-8 encoded string together with a unique ID. All
-'FastString's are stored in a global hashtable to support fast O(1)
+{-| A 'FastString' is a Modified UTF-8 encoded string together with a unique ID.
+All 'FastString's are stored in a global hashtable to support fast O(1)
 comparison.
 
 It is also associated with a lazy reference to the Z-encoding


=====================================
libraries/ghc-boot/GHC/Data/ShortText.hs
=====================================
@@ -24,6 +24,10 @@
 
 -- Very similar to FastString, but not hash-consed and with some extra instances and
 -- functions for serialisation and I/O. Should be imported qualified.
+--
+-- /Note:/ This string is stored in Modified UTF8 format,
+-- thus it's not byte-compatible with @ShortText@ type in @text-short@
+-- package.
 
 module GHC.Data.ShortText (
         -- * ShortText


=====================================
libraries/ghc-boot/GHC/Utils/Encoding/UTF8.hs
=====================================
@@ -7,7 +7,7 @@
 -- of the package database (needed in both ghc and in ghc-pkg) lives in
 -- `ghc-boot` and uses ShortText, which in turn depends on this module.
 
--- | Simple, non-streaming UTF-8 codecs.
+-- | Simple, non-streaming Modified UTF-8 codecs.
 --
 -- This is one of several UTF-8 implementations provided by GHC; see Note
 -- [GHC's many UTF-8 implementations] in "GHC.Encoding.UTF8" for an



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/0255d03c302c1b83367edae169fee0b4a4306965

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/0255d03c302c1b83367edae169fee0b4a4306965
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240412/1e66c3d6/attachment-0001.html>