GitLab

Oleg Grenrus pushed to branch wip/shorter-this-module-links at Glasgow Haskell Compiler / GHC

Commits:

4d5bccf8

by Oleg Grenrus at 2025-09-14T18:46:13+03:00

Use showUnique in internalAnchorIdent

Showing the key of Unique as a number is generally not a great idea.
GHC Unique has a tag in high bits, so the raw number is unnecessarily
big.

So now we have

```html
<a href="#l-rvgK"><span class="hs-identifier hs-var hs-var">bar</span></a>
```

instead of

```html
<a href="#local-6989586621679015689"><span class="hs-identifier hs-var hs-var">bar</span></a>
```

Together with previous changes of shorter intra-module links the effect
on compressed files is not huge, that is expected as we simply remove
repetitive contents which pack well.

```
12_694_206  Agda-2.9.0-docs-orig.tar.gz
12_566_065  Agda-2.9.0-docs.tar.gz
```

However when unpacked, the difference can be significant,
e.g. Agda's largest module source got 5% reduction:

```
14_230_117  Agda.Syntax.Parser.Parser.html
13_422_109  Agda.Syntax.Parser.Parser.html
```

The whole hyperlinked source code directory got similar reduction

```
121M	Agda-2.9.0-docs-orig/src
114M	Agda-2.9.0-docs/src
```

For the reference, sources are about 2/3 of the generated haddocks

```
178M	Agda-2.9.0-docs-old
172M	Agda-2.9.0-docs
```

so we get around 3.5% size reduction overall. Not bad for a small local
changes.

24 changed files:

libffi-tarballs
libraries/Cabal
libraries/Win32
libraries/array
libraries/containers
libraries/deepseq
libraries/directory
libraries/exceptions
libraries/filepath
libraries/haskeline
libraries/hpc
libraries/os-string
libraries/parsec
libraries/process
libraries/semaphore-compat
libraries/stm
libraries/terminfo
libraries/text
libraries/time
libraries/unix
nofib
utils/haddock/haddock-api/src/Haddock/Backends/Hyperlinker/Renderer.hs
utils/hpc
utils/hsc2hs

Changes:

libffi-tarballs

1		-Subproject commit 7c51059557b68d29820a0a87cebfa6fe73c8adf5
	1	+Subproject commit 89a9b01c5647c8f0d3899435b99df690f582e9f1

libraries/Cabal

1		-Subproject commit d9b0904b49dc84e0bfc79062daf2bbdf9d22a422
	1	+Subproject commit 269fd808e5d80223a229b6b19edfe6f5b109007a

libraries/Win32

1		-Subproject commit 7d0772bb265a6c59eb14c441cf65c778895528df
	1	+Subproject commit 027cbcf0de25d681823ea92fb545a2604c3a6a8b

libraries/array

1		-Subproject commit 6d59d5deb4f2a12656ab4c4371c0d12dac4875ef
	1	+Subproject commit e7ffb82fd40134da21d7642a41568f32c77c1a04

libraries/containers

1		-Subproject commit 801b06e5d4392b028e519d5ca116a2881d559721
	1	+Subproject commit 4fda06c43ea14f808748aa8988158946c3ce0caf

libraries/deepseq

1		-Subproject commit ae2762ac241a61852c9ff4c287af234fb1ad931f
	1	+Subproject commit af115cc226cc87fba89d0f6e2e9212e755c24983

libraries/directory

1		-Subproject commit 6442a3cf04f74d82cdf8c9213324313d52b23d28
	1	+Subproject commit 005fa061171a55d35ce8dfe936cf3703525a8616

libraries/exceptions

1		-Subproject commit b6c4290124eb1138358bf04ad9f33e67f6c5c1d8
	1	+Subproject commit 8e55b720f45db91f4895f710863ef9dbc10fe569

libraries/filepath

1		-Subproject commit cbcd0ccf92f47e6c10fb9cc513a7b26facfc19fe
	1	+Subproject commit 65b0f8f31aac4a306135e27734988327f8eb1e6f

libraries/haskeline

1		-Subproject commit 991953cd5d3bb9e8057de4a0d8f2cae3455865d8
	1	+Subproject commit 5f4bf62bf1f4846ad0b8d1fa9d45f902e3934511

libraries/hpc

1		-Subproject commit 12675279dc5cbea4ade8b5157b080390d598f03f
	1	+Subproject commit f321056015dc36b454f323ca4285d684f4f782d3

libraries/os-string

1		-Subproject commit 2e693aad07540173a0169971b27c9acac28eeff1
	1	+Subproject commit 4b5efedcd2da9314edda80d973a44e67020370db

libraries/parsec

1		-Subproject commit 552730e23e1fd2dae46a60d75138b8d173492462
	1	+Subproject commit b87122c1c74b8240e65044a8f600f0427d4dd9c3

libraries/process

1		-Subproject commit ae50731b5fb221a7631f7e9d818fc6716c85c51e
	1	+Subproject commit 9c3bfc214c72bbd0c8a30a1c41465deed0feaf47

libraries/semaphore-compat

1		-Subproject commit ba87d1bb0209bd9f29bda1c878ddf345f8a2b199
	1	+Subproject commit 54882cd9a07322a4cf95d4fc0627107eaf1eb051

libraries/stm

1		-Subproject commit 23bdcc2319965911af28542e76fc01f37c107d40
	1	+Subproject commit def18948f42a2eb8c34efdf65f7e614d1f6d5703

libraries/terminfo

1		-Subproject commit 16db154e3e97e6bff62329574163851a7090f3b6
	1	+Subproject commit 788ce671cb1cec54c3c9b3ac1c1ba189e8424819

libraries/text

1		-Subproject commit 5f343f668f421bfb30cead594e52d0ac6206ff67
	1	+Subproject commit b86564cae8d7262c7c4e7afe7a9163c83de3f175

libraries/time

1		-Subproject commit 507f50844802f1469ba6cadfeefd4e3fecee0416
	1	+Subproject commit e5c5d1987011efe88a21ab6ded45aaa33a16274f

libraries/unix

1		-Subproject commit c9b3e95b5c15b118e55522bd92963038c6a88160
	1	+Subproject commit 74ae1c0d9dd1518434f7d6cd3e63d7769599e0f9

nofib

1		-Subproject commit b7391df4540ac8b11b35e1b2e2c15819b5171798
	1	+Subproject commit da7eed00e494aba1da9f51cb92089ca10e2454e7

utils/haddock/haddock-api/src/Haddock/Backends/Hyperlinker/Renderer.hs

@@ -14,7 +14,7 @@ import GHC.Iface.Ext.Types
  import GHC.Iface.Ext.Utils (emptyNodeInfo, isEvidenceContext)
  import GHC.Types.Name (Name, getOccString, isInternalName, nameModule, nameUnique)
  import GHC.Types.SrcLoc
 -import GHC.Types.Unique (getKey)
 +import GHC.Types.Unique (showUnique)
  import GHC.Unit.Module (Module, ModuleName, moduleNameString)
  import GHC.Utils.Encoding (utf8DecodeByteString)
  import System.FilePath.Posix ((</>))
@@ -254,7 +254,7 @@ externalAnchorIdent :: Name -> String
  externalAnchorIdent = hypSrcNameUrl
  internalAnchorIdent :: Name -> String
 -internalAnchorIdent = ("local-" ++) . show . getKey . nameUnique
 +internalAnchorIdent = ("l-" ++) . showUnique . nameUnique
  -- | Generate the HTML hyperlink for an identifier
  hyperlink :: Module -> SrcMaps -> Identifier -> Html -> Html

utils/hpc

1		-Subproject commit 5923da3fe77993b7afc15b5163cffcaa7da6ecf5
	1	+Subproject commit d1780eb21c1e5a1227fff80c8d325d5142f04255

utils/hsc2hs

1		-Subproject commit fe3990b9f35000427b016a79330d9f195587cad8
	1	+Subproject commit c3b21800a67366c9591dc85a471d1dfdb1efcf29