GitLab

Zubin pushed to branch wip/26635 at Glasgow Haskell Compiler / GHC

Commits:

b14f8557

by Zubin Duggal at 2026-03-31T11:06:16+05:30

hadrian: Don't include the package hash in the haddock directory

Since GHC 9.8 and hash_unit_ids, haddock urls have looked like`ghc-9.10.3/doc/html/libraries/base-4.20.2.0-39f9/**/*.html`

The inclusion of the hash makes it hard for downstream non-boot packages to properly link to these files, as the hash is not
part of a standard cabal substitution.

Since we only build one version of each package, we don't need the hash to disambiguate anything, we can just remove it.

Fixes #26635

4 changed files:

hadrian/bindist/Makefile
hadrian/src/CommandLine.hs
hadrian/src/Context.hs
hadrian/src/Settings/Builders/Cabal.hs

Changes:

hadrian/bindist/Makefile

@@ -205,7 +205,7 @@ update_package_db: install_bin install_lib
  	$(INSTALL_DATA) mk/system-cxx-std-lib-1.0.conf "$(DESTDIR)$(ActualLibsDir)/package.conf.d"
  	@echo "Updating the package DB"
  	$(foreach p, $(PKG_CONFS),\
 -		$(call patchpackageconf,$(shell echo $(notdir $p) | sed 's/-[0-9.]*-[0-9a-zA-Z]*\.conf//g'),$(shell echo "$p" | sed 's:\0xxx\0:   :g'),$(docdir),$(shell mk/relpath.sh "$(ActualLibsDir)" "$(docdir)"),$(shell echo $(notdir $p) | sed 's/.conf//g')))
 +		$(call patchpackageconf,$(shell echo $(notdir $p) | sed 's/-[0-9.]*-[0-9a-zA-Z]*\.conf//g'),$(shell echo "$p" | sed 's:\0xxx\0:   :g'),$(docdir),$(shell mk/relpath.sh "$(ActualLibsDir)" "$(docdir)"),$(shell echo $(notdir $p) | sed 's/-[0-9a-zA-Z]*\.conf$$//')))
  	'$(DESTDIR)$(ActualBinsDir)/$(CrossCompilePrefix)ghc-pkg' --global-package-db "$(DESTDIR)$(ActualLibsDir)/package.conf.d" recache
  .PHONY: install_mingw

hadrian/src/CommandLine.hs

@@ -114,7 +114,7 @@ data DocArgs = DocArgs
    } deriving (Eq, Show)
  defaultDocArgs :: DocArgs
 -defaultDocArgs = DocArgs { docsBaseUrl = "../%pkgid%" }
 +defaultDocArgs = DocArgs { docsBaseUrl = "../%pkg%" }
  readConfigure :: Either String (CommandLineArgs -> CommandLineArgs)
  readConfigure = Left "hadrian --configure has been deprecated (see #20167). Please run ./boot; ./configure manually"

hadrian/src/Context.hs

@@ -120,7 +120,9 @@ pkgSetupConfigFile context = pkgSetupConfigDir context <&> (-/- "setup-config")
  pkgHaddockFile :: Context -> Action FilePath
  pkgHaddockFile Context {..} = do
      root <- buildRoot
 -    version <- pkgUnitId stage package
 +    -- We don't want to use the hash in the html documentation because it
 +    -- makes it harder for non-boot packages to link to boot packages, see #26635
 +    version <- pkgSimpleIdentifier package
      return $ root -/- "doc/html/libraries" -/- version -/- pkgName package <.> "haddock"
  -- | Path to the registered ghc-pkg library file of a given 'Context', e.g.:

hadrian/src/Settings/Builders/Cabal.hs

@@ -83,6 +83,9 @@ commonCabalArgs :: Stage -> Args
  commonCabalArgs stage = do
    pkg       <- getPackage
    package_id <- expr $ pkgUnitId stage pkg
 +  -- We don't want to use the hash in the html documentation because it
 +  -- makes it harder for non-boot packages to link to boot packages, see #26635
 +  package_simple_id <- expr $ pkgSimpleIdentifier pkg
    let prefix = "${pkgroot}" ++ (if windowsHost then "" else "/..")
    mconcat [ -- Don't strip libraries when cross compiling.
              -- TODO: We need to set @--with-strip=(stripCmdPath :: Action FilePath)@,
@@ -110,7 +113,7 @@ commonCabalArgs stage = do
              --
              -- This doesn't hold if we move the @doc@ folder anywhere else.
              , arg "--htmldir"
 -            , arg $ "${pkgroot}/../../doc/html/libraries/" ++ package_id
 +            , arg $ "${pkgroot}/../../doc/html/libraries/" ++ package_simple_id
              -- These trigger a need on each dependency, so every important to need
              -- them in parallel or  it linearises the build of Ghc and GhcPkg