Mon Nov 20 20:52:22 UTC 2017

Repository : ssh://git@git.haskell.org/haddock

On branches: 2.17.3.1-spanfix,alexbiehl-patch-1,ghc-8.0,ghc-8.0-facebook,ghc-head,ghc-head1,haddock-quick,headdock-library-1.4.5,ie_avails,issue-303,issue-475,master,pr-filter-maps,pr/cabal-desc,travis,v2.16,v2.17,v2.17.3,v2.18,wip-located-module-as,wip/D2418,wip/T11080-open-data-kinds,wip/T11258,wip/T11430,wip/T12105,wip/T12105-2,wip/T12942,wip/T13163,wip/T3384,wip/embelleshed-rdr,wip/new-tree-one-param,wip/rae,wip/remove-frames,wip/remove-frames1,wip/revert-ttg-2017-11-20,wip/ttg-2017-10-13,wip/ttg-2017-10-31,wip/ttg-2017-11-06,wip/ttg2-2017-11-10,wip/ttg3-2017-11-12,wip/ttg4-constraints-2017-11-13
Link       : http://git.haskell.org/haddock.git/commitdiff/96a118be9d02cc433f0982ca728e5c80a2c4c8af

>---------------------------------------------------------------

commit 96a118be9d02cc433f0982ca728e5c80a2c4c8af
Author: Łukasz Hanuszczak <lukasz.hanuszczak at gmail.com>
Date:   Fri Jul 31 18:24:40 2015 +0200

    Make section identifier of instance details more GHC-independent.


>---------------------------------------------------------------

96a118be9d02cc433f0982ca728e5c80a2c4c8af
 haddock-api/src/Haddock/Backends/Xhtml/Decl.hs | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/haddock-api/src/Haddock/Backends/Xhtml/Decl.hs b/haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
index 35e5c5f..c30d0e6 100644
--- a/haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
+++ b/haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
@@ -39,7 +39,6 @@ import           Text.XHtml hiding     ( name, title, p, quote )
 
 import GHC
 import GHC.Exts
-import Unique
 import Name
 import BooleanFormula
 
@@ -609,8 +608,8 @@ instanceId :: InstOrigin -> Int -> InstHead DocName -> String
 instanceId orgin no ihd = concat
     [ qual orgin
     , ":" ++ (occNameString . getOccName . ihdClsName) ihd
-    , "-" ++ show (instHeadId ihd)
-    , "-" ++ show no
+    , ":" ++ show (instHeadId ihd)
+    , ":" ++ show no
     ]
   where
     qual OriginClass = "ic"
@@ -626,16 +625,27 @@ instanceId orgin no ihd = concat
 -- refactoring, for now we just generate naive hash for given instance.
 --
 -- Hashing is very, very trivial and turns a list of 'DocName' to 'Int'. Idea
--- for such simple hash function is stolen from
+-- for such simple hash function (djb2) is stolen from
 -- <http://stackoverflow.com/questions/9262879/create-a-unique-integer-for-each-string here>.
+--
+-- Hashing is performed on string representation of `Name`. Why string instead
+-- of 'Unique' of that 'Name'? That would be much faster and nicer, yes.
+-- However, 'Unique' is not very deterministic, so running it on different
+-- configurations would yield different HTML documents. This is not very bad,
+-- as nobody cares about these identifiers but it would require us to strip
+-- section anchors in testing framework and that is not only inconvenient but
+-- also makes testing less viable. And it is only temporary solution so we can
+-- live with it.
 instHeadId :: InstHead DocName -> Int
 instHeadId (InstHead { .. }) =
     djb2 . map key $ [ihdClsName] ++ names ihdTypes ++ names ihdKinds
   where
     names = everything (++) $
         maybeToList . (cast :: forall a. Data a => a -> Maybe DocName)
-    djb2 = foldl (\h c -> h * 33 `xor` c) 5381
-    key = getKey . nameUnique . getName
+    key = djb2 . occNameString . nameOccName . getName
+
+    djb2 :: Enum a => [a] -> Int
+    djb2 = foldl (\h c -> h * 33 `xor` fromEnum c) 5381
 
 
 -------------------------------------------------------------------------------

