Stack项目中的GHC-Paths构建失败问题分析与修复

在Stack 2.15.7版本中，用户报告了一个关于ghc-paths包构建失败的回归问题。这个问题主要出现在使用较旧GHC版本（LTS-18及更早版本）的环境中，具体表现为在构建过程中出现"parse error on input 'import'"的编译错误。

问题现象

当用户尝试构建依赖ghc-paths的包时（如doctest），构建过程会在ghc-paths包的配置阶段失败。错误信息显示，在编译StackSetupShim模块时，GHC无法解析import语句，尽管代码看起来完全合法。

典型的错误输出如下：

/home/user/.stack/setup-exe-src/setup-shim-HwdwpEmb.hs:10:1: error:
    parse error on input 'import'
   |
10 | import Data.List ( stripPrefix )
   | ^^^^^^

问题根源分析

经过深入调查，发现问题源于两个因素的组合：

1. Haddock注释位置：setup-shim模块中在import语句前使用了-- | 风格的Haddock注释
2. GHC编译选项：构建过程中启用了-haddock选项

在GHC 8.10.7及更早版本中，这种特定组合会导致解析错误。值得注意的是，单独使用其中任何一个因素都不会引发问题，只有两者同时存在时才会触发这个边界情况。

技术背景

Haddock是Haskell的标准文档工具，-- | 风格的注释专门用于为后续声明生成文档。在正常情况下，这种注释应该可以出现在任何声明前，包括import语句。

GHC的-haddock选项指示编译器在处理源代码时同时处理Haddock注释。在某些旧版本中，当这个选项与import语句前的Haddock注释结合时，会出现解析异常。

解决方案

修复方案相对简单直接：

1. 移除setup-shim模块中import语句前的Haddock注释
2. 或者保留注释但确保不在构建时启用-haddock选项

Stack团队选择了第一个方案，因为这不会影响实际功能，同时避免了与旧GHC版本的兼容性问题。这个修复已经包含在Stack 3.1.1版本中。

经验教训

这个案例展示了几个重要的开发实践：

1. 版本兼容性测试的重要性：即使改动看似无害，也需要在各种环境下充分测试
2. 边界情况处理：某些功能组合可能产生意料之外的行为
3. 构建系统复杂性：构建工具链中的细微差别可能导致难以诊断的问题

对于Haskell开发者来说，这个案例也提醒我们注意GHC版本间的行为差异，特别是在处理文档注释和构建选项时。