add link to docs in warning

DLR-AMR · Nov 6, 2023 · 0a28f20 · 0a28f20
1 parent 6cbbae9
commit 0a28f20
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/dev/prologue.jl b/dev/prologue.jl
@@ -5,23 +5,23 @@ using ..T8code: _PREFERENCE_LIBT8, _PREFERENCE_LIBP4EST, _PREFERENCE_LIBSC
 using MPIPreferences: MPIPreferences
 
 @static if _PREFERENCE_LIBT8 == "t8code_jll" && MPIPreferences.binary == "system"
-    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
 elseif _PREFERENCE_LIBP4EST == "t8code_jll"
     const libt8 = t8code_jll.libt8
 else
     const libt8 = _PREFERENCE_LIBT8
 end
 
 @static if _PREFERENCE_LIBP4EST == "t8code_jll" && MPIPreferences.binary == "system"
-    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
 elseif _PREFERENCE_LIBP4EST == "t8code_jll"
     const libp4est = t8code_jll.libp4est
 else
     const libp4est = _PREFERENCE_LIBP4EST
 end
 
 @static if _PREFERENCE_LIBSC == "t8code_jll" && MPIPreferences.binary == "system"
-    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
 elseif _PREFERENCE_LIBP4EST == "t8code_jll"
     const libsc = t8code_jll.libsc
 else

diff --git a/src/Libt8.jl b/src/Libt8.jl
@@ -14,23 +14,23 @@ using ..T8code: _PREFERENCE_LIBT8, _PREFERENCE_LIBP4EST, _PREFERENCE_LIBSC
 using MPIPreferences: MPIPreferences
 
 @static if _PREFERENCE_LIBT8 == "t8code_jll" && MPIPreferences.binary == "system"
-    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
 elseif _PREFERENCE_LIBP4EST == "t8code_jll"
     const libt8 = t8code_jll.libt8
 else
     const libt8 = _PREFERENCE_LIBT8
 end
 
 @static if _PREFERENCE_LIBP4EST == "t8code_jll" && MPIPreferences.binary == "system"
-    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
 elseif _PREFERENCE_LIBP4EST == "t8code_jll"
     const libp4est = t8code_jll.libp4est
 else
     const libp4est = _PREFERENCE_LIBP4EST
 end
 
 @static if _PREFERENCE_LIBSC == "t8code_jll" && MPIPreferences.binary == "system"
-    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+    @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
 elseif _PREFERENCE_LIBP4EST == "t8code_jll"
     const libsc = t8code_jll.libsc
 else

diff --git a/src/T8code.jl b/src/T8code.jl
@@ -198,7 +198,7 @@ end
 
 function __init__()
     if !preferences_set_correctly()
-       @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences."
+       @warn "System MPI version detected, but not a system t8code version. To make T8code.jl work, you need to set the preferences, see https://github.com/DLR-AMR/T8code.jl#using-a-custom-version-of-mpi-andor-t8code."
     end
 end