Skip to content

Commit 162653a

Browse files
committed
Rename abi_file --> abi_source_file
1 parent 573ae38 commit 162653a

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/src/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ enum {
123123

124124
#define MPI_ARGV_NULL ((char**) NULL)
125125
```
126-
you need to put the corresponding entries in your ABI file `abi_file.jl`:
126+
you need to put the corresponding entries in your ABI file `abi_source_file.jl`:
127127
```julia
128128
const MPI_Request = Cuint
129129
@const_ref MPI_REQUEST_NULL MPI_Request 0
@@ -139,10 +139,10 @@ Please note that sometimes information is also stored in ancillary header files
139139
`mpi_types.h` or `mpi_ext.h`).
140140

141141
You can then use [`MPIPreferences.use_system_binary`](@ref) to configure MPI.jl
142-
to use your custom file by providing the path via the `abi_file` keyword
142+
to use your custom file by providing the path via the `abi_source_file` keyword
143143
argument, e.g.,
144144
```shell
145-
julia --project -e 'using MPIPreferences; MPIPreferences.use_system_binary(; abi_file="path/to/abifile.jl)'
145+
julia --project -e 'using MPIPreferences; MPIPreferences.use_system_binary(; abi_source_file="path/to/file.jl)'
146146
```
147147
You need to restart Julia for the change to take effect.
148148

lib/MPIPreferences/src/MPIPreferences.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ end
4747

4848
# Default is empty string, indicating that the information in `abi` should be used to load the
4949
# correct ABI file
50-
const abi_file = @load_preference("abi_file", "")
50+
const abi_source_file = @load_preference("abi_source_file", "")
5151

5252
"""
5353
MPIPreferences.use_jll_binary(binary; export_prefs=false, force=true)
@@ -93,7 +93,7 @@ end
9393
library_names = ["libmpi", "libmpi_ibm", "msmpi", "libmpich", "libmpitrampoline"],
9494
mpiexec = "mpiexec",
9595
abi = nothing,
96-
abi_file = nothing,
96+
abi_source_file = nothing,
9797
export_prefs = false,
9898
force = true)
9999
@@ -115,7 +115,7 @@ Options:
115115
- `abi`: the ABI of the MPI library. By default this is determined automatically
116116
using [`identify_abi`](@ref). See [`abi`](@ref) for currently supported values.
117117
118-
- `abi_file`: the ABI file for the MPI library. By default, for ABIs supported by MPI.jl, the
118+
- `abi_source_file`: the ABI file for the MPI library. By default, for ABIs supported by MPI.jl, the
119119
corresponding ABI file is loaded automatically. This argument allows one to override the
120120
automatic selection, e.g., to provide an ABI file for an MPI ABI unknown to MPI.jl.
121121
@@ -127,7 +127,7 @@ function use_system_binary(;
127127
library_names=["libmpi", "libmpi_ibm", "msmpi", "libmpich", "libmpitrampoline"],
128128
mpiexec="mpiexec",
129129
abi=nothing,
130-
abi_file=nothing,
130+
abi_source_file=nothing,
131131
export_prefs=false,
132132
force=true,
133133
)
@@ -142,10 +142,10 @@ function use_system_binary(;
142142
if isnothing(abi)
143143
abi = identify_abi(libmpi)
144144
end
145-
if isnothing(abi_file)
146-
abi_file = ""
145+
if isnothing(abi_source_file)
146+
abi_source_file = ""
147147
else
148-
abi_file = abspath(abi_file)
148+
abi_source_file = abspath(abi_source_file)
149149
end
150150
if mpiexec isa Cmd
151151
mpiexec = collect(mpiexec)
@@ -154,13 +154,13 @@ function use_system_binary(;
154154
"binary" => binary,
155155
"libmpi" => libmpi,
156156
"abi" => abi,
157-
"abi_file" => abi_file,
157+
"abi_source_file" => abi_source_file,
158158
"mpiexec" => mpiexec,
159159
export_prefs=export_prefs,
160160
force=force
161161
)
162162

163-
@warn "The underlying MPI implementation has changed. You will need to restart Julia for this change to take effect" binary libmpi abi abi_file mpiexec
163+
@warn "The underlying MPI implementation has changed. You will need to restart Julia for this change to take effect" binary libmpi abi abi_source_file mpiexec
164164

165165
if VERSION <= v"1.6.5" || VERSION == v"1.7.0"
166166
@warn """

src/consts/consts.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ macro const_ref(name, T, expr)
2727
:(const $(esc(name)) = Ref{$T}())
2828
end
2929

30-
# If `abi_file` is empty, choose ABI file based on ABI string, otherwise load the specified file
31-
@static if MPIPreferences.abi_file == ""
30+
# If `abi_source_file` is empty, choose ABI file based on ABI string, otherwise load the specified file
31+
@static if MPIPreferences.abi_source_file == ""
3232
@static if MPIPreferences.abi == "MPICH"
3333
include("mpich.jl")
3434
elseif MPIPreferences.abi == "OpenMPI"
@@ -43,7 +43,7 @@ end
4343
error("Unknown MPI ABI $(MPIPreferences.abi)")
4444
end
4545
else
46-
include(MPIPreferences.abi_file)
46+
include(MPIPreferences.abi_source_file)
4747
end
4848

4949
# Initialize the ref constants from the library.

0 commit comments

Comments
 (0)