Skip to content

Commit 7f725bc

Browse files
committed
Docs fix
1 parent 1f61d30 commit 7f725bc

File tree

4 files changed

+8
-54
lines changed

4 files changed

+8
-54
lines changed

src/compiler/execution.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ kernel = @oneapi launch=false vadd(a, b, c)
5353
kernel(a, b, c; groups=4, items=256) # Launch later
5454
```
5555
56-
See also: [`zefunction`](@ref), [`kernel_convert`](@ref)
56+
See also: `zefunction`, `kernel_convert`
5757
"""
5858
macro oneapi(ex...)
5959
call = ex[end]

src/compiler/reflection.jl

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -47,52 +47,6 @@ const code_spirv = code_native
4747
# @device_code_* functions
4848
#
4949

50-
"""
51-
@device_code_lowered [kwargs...] expr
52-
@device_code_typed [kwargs...] expr
53-
@device_code_warntype [kwargs...] expr
54-
@device_code_llvm [kwargs...] expr
55-
@device_code_spirv [kwargs...] expr
56-
@device_code [kwargs...] expr
57-
58-
Macros for inspecting code generation at various stages of compilation for GPU kernels.
59-
60-
These macros are useful for debugging kernel compilation issues and understanding how
61-
Julia code is translated to GPU code.
62-
63-
# Available Macros
64-
65-
- `@device_code_lowered`: Show lowered IR (desugared Julia code)
66-
- `@device_code_typed`: Show type-inferred IR
67-
- `@device_code_warntype`: Show type-inferred IR with type stability warnings
68-
- `@device_code_llvm`: Show LLVM IR
69-
- `@device_code_spirv`: Show SPIR-V assembly
70-
- `@device_code`: Show all compilation stages interactively
71-
72-
# Examples
73-
74-
```julia
75-
function kernel(a, b)
76-
i = get_global_id()
77-
@inbounds a[i] = b[i] + 1.0f0
78-
return
79-
end
80-
81-
a = oneArray(zeros(Float32, 10))
82-
b = oneArray(rand(Float32, 10))
83-
84-
# Check LLVM IR
85-
@device_code_llvm @oneapi groups=1 items=10 kernel(a, b)
86-
87-
# Check SPIR-V assembly
88-
@device_code_spirv @oneapi groups=1 items=10 kernel(a, b)
89-
90-
# Check type stability
91-
@device_code_warntype @oneapi groups=1 items=10 kernel(a, b)
92-
```
93-
94-
See also: [`@oneapi`](@ref), [`return_type`](@ref)
95-
"""
9650
export @device_code_lowered, @device_code_typed, @device_code_warntype,
9751
@device_code_llvm, @device_code_spirv,
9852
@device_code

src/context.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ drv = driver()
2222
println("Using driver: ", drv)
2323
```
2424
25-
See also: [`driver!`](@ref), [`drivers`](@ref)
25+
See also: `driver!`, `drivers`
2626
"""
2727
function driver()
2828
get!(task_local_storage(), :ZeDriver) do
@@ -47,7 +47,7 @@ drv = drivers()[2] # Select second available driver
4747
driver!(drv)
4848
```
4949
50-
See also: [`driver`](@ref), [`drivers`](@ref)
50+
See also: `driver`, `drivers`
5151
"""
5252
function driver!(drv::ZeDriver)
5353
task_local_storage(:ZeDriver, drv)
@@ -68,7 +68,7 @@ dev = device()
6868
println("Using device: ", dev)
6969
```
7070
71-
See also: [`device!`](@ref), [`devices`](@ref), [`driver`](@ref)
71+
See also: `device!`, `devices`, `driver`
7272
"""
7373
function device()
7474
get!(task_local_storage(), :ZeDevice) do
@@ -148,7 +148,7 @@ ctx = ZeContext(driver())
148148
context!(ctx)
149149
```
150150
151-
See also: [`context`](@ref), [`ZeContext`](@ref)
151+
See also: `context`, `ZeContext`
152152
"""
153153
function context!(ctx::ZeContext)
154154
task_local_storage(:ZeContext, ctx)
@@ -178,7 +178,7 @@ dev = device()
178178
queue = global_queue(ctx, dev)
179179
```
180180
181-
See also: [`context`](@ref), [`device`](@ref), [`synchronize`](@ref)
181+
See also: `context`, `device`, `synchronize`
182182
"""
183183
function global_queue(ctx::ZeContext, dev::ZeDevice)
184184
# NOTE: dev purposefully does not default to context() or device() to stress that
@@ -232,7 +232,7 @@ drv = drivers()[1]
232232
devs = devices(drv)
233233
```
234234
235-
See also: [`device`](@ref), [`device!`](@ref), [`drivers`](@ref)
235+
See also: `device`, `device!`, `drivers`
236236
"""
237237
oneL0.devices() = devices(driver())
238238

src/utils.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ end
6868
6969
Run expression `ex` and synchronize the GPU afterwards.
7070
71-
See also: [`synchronize`](@ref).
71+
See also: `synchronize`.
7272
"""
7373
macro sync(ex)
7474
quote

0 commit comments

Comments
 (0)