[Git][ghc/ghc][master] 2 commits: Make Z-encoding comment into a note

[Marge Bot]

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


Commits:
5c7387f6 by Leif Metcalf at 2020-09-17T08:51:43-04:00
Make Z-encoding comment into a note

- - - - -
c12b3041 by Leif Metcalf at 2020-09-17T08:51:43-04:00
Cosmetic

- - - - -


2 changed files:

- compiler/GHC/Data/FastString.hs
- compiler/GHC/Utils/Encoding.hs


Changes:

=====================================
compiler/GHC/Data/FastString.hs
=====================================
@@ -196,7 +196,8 @@ data FastString = FastString {
       n_chars :: {-# UNPACK #-} !Int, -- number of chars
       fs_sbs  :: {-# UNPACK #-} !ShortByteString,
       fs_zenc :: FastZString
-      -- ^ Lazily computed z-encoding of this string.
+      -- ^ Lazily computed Z-encoding of this string. See Note [Z-Encoding] in
+      -- GHC.Utils.Encoding.
       --
       -- Since 'FastString's are globally memoized this is computed at most
       -- once for any given string.


=====================================
compiler/GHC/Utils/Encoding.hs
=====================================
@@ -277,7 +277,8 @@ utf8EncodedLength str = go 0 str
           | otherwise       = go (n+4) cs
 
 -- -----------------------------------------------------------------------------
--- The Z-encoding
+-- Note [Z-Encoding]
+-- ~~~~~~~~~~~~~~~~~
 
 {-
 This is the main name-encoding and decoding function.  It encodes any



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/147bb59826087300f989addfcf79e3956f6ed66b...c12b3041e533962b8d0ac9ee44e928f874c11671

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/147bb59826087300f989addfcf79e3956f6ed66b...c12b3041e533962b8d0ac9ee44e928f874c11671
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/20200917/98bdb3d5/attachment.html>