summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZubin Duggal <zubin.duggal@gmail.com>2022-05-17 16:16:09 +0530
committerZubin Duggal <zubin.duggal@gmail.com>2022-05-17 16:33:58 +0530
commita1c2e6e7722545fc3070ff73032ec6f2ef7d02d6 (patch)
treec215f9a094c35283f8abf35abe8e776e6b093bc1
parent5f6527e05beb628c5015ab9f8a7f4012ee8d14a1 (diff)
downloadhaskell-wip/llvm-version-man.tar.gz
docs: Fix LlvmVersion in manpage (#21280)wip/llvm-version-man
-rw-r--r--docs/users_guide/codegens.rst4
-rw-r--r--docs/users_guide/conf.py5
-rw-r--r--docs/users_guide/ghc_config.py.in3
3 files changed, 7 insertions, 5 deletions
diff --git a/docs/users_guide/codegens.rst b/docs/users_guide/codegens.rst
index 441d4900d6..e9b696fe0e 100644
--- a/docs/users_guide/codegens.rst
+++ b/docs/users_guide/codegens.rst
@@ -50,8 +50,8 @@ compiler <https://clang.llvm.org>`__ compiler available on your ``PATH``.
.. note::
- Note that this GHC release expects an LLVM version in the |llvm-version|
- release series.
+ Note that this GHC release expects an LLVM version in the |llvm-version-min|
+ up to |llvm-version-max| (not inclusive) release series.
To install LLVM and Clang:
diff --git a/docs/users_guide/conf.py b/docs/users_guide/conf.py
index 04631fc363..a7ad65ae83 100644
--- a/docs/users_guide/conf.py
+++ b/docs/users_guide/conf.py
@@ -41,8 +41,9 @@ nitpick_ignore = [
]
rst_prolog = """
-.. |llvm-version| replace:: {llvm_version}
-""".format(llvm_version=ghc_config.llvm_version)
+.. |llvm-version-min| replace:: {llvm_version_min}
+.. |llvm-version-max| replace:: {llvm_version_max}
+""".format(llvm_version_min=ghc_config.llvm_version_min, llvm_version_max=ghc_config.llvm_version_max)
# General information about the project.
project = u'Glasgow Haskell Compiler'
diff --git a/docs/users_guide/ghc_config.py.in b/docs/users_guide/ghc_config.py.in
index e2f5c71d5d..dcc7fbaef6 100644
--- a/docs/users_guide/ghc_config.py.in
+++ b/docs/users_guide/ghc_config.py.in
@@ -20,4 +20,5 @@ lib_versions = {
version = '@ProjectVersion@'
-llvm_version = '@LlvmVersion@'
+llvm_version_min = '@LlvmMinVersion@'
+llvm_version_max = '@LlvmMaxVersion@'