Skip to content

Commit deec9d4

Browse files
authored
add compatibility warning to README (#636)
* add compatibility warning to README * add note for nightly users
1 parent 3df1208 commit deec9d4

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11
# Cthulhu.jl [![CI](https://github.com/JuliaDebug/Cthulhu.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaDebug/Cthulhu.jl/actions/workflows/CI.yml)
22

3-
*The slow descent into madness*
4-
5-
:warning: The latest stable version is only compatible with Julia v1.8.5 and higher.
3+
> *The slow descent into madness*
4+
5+
> [!warning]
6+
> This package relies on internal APIs of the Julia base compiler.
7+
> As such, its behavior may change depending on your Julia version.
8+
> For maintenance reasons, the latest version of Cthulhu (typically managed in the `master`
9+
> branch) does not guarantee compatibility with older Julia versions.
10+
> Versions of Cthulhu compatible with earlier Julia releases may be maintained in dedicated branches[^old-version-branch-ex].
11+
>
12+
> Please refer to the `Project.toml` file for details on supported Julia versions.
13+
> Generally, Julia's package manager automatically selects a compatible Cthulhu version for
14+
> your Julia installation.
15+
> If you simply want to use Cthulhu, running `pkg> add Cthulhu` will install an appropriate version.
16+
>
17+
> **Note for nightly users:**
18+
> If you're using the latest Julia nightly build, we recommend regularly checking that your
19+
> Cthulhu installation is up-to-date (`pkg> update Cthulhu`) to have compatibility with
20+
> recent internal changes.
21+
22+
[^old-version-branch-ex]: For example, Cthulhu code compatible with Julia v1.10 and v1.11 is
23+
maintained in the [`2.16`](https://github.com/JuliaDebug/Cthulhu.jl/tree/2.16) branch.
624

725
Cthulhu can help you debug type inference issues by recursively showing the
826
type-inferred code until you find the exact point where inference gave up,

0 commit comments

Comments
 (0)