JuliaGPU/CUDA.jl

Document Mem.pin more explicitly to make it more findable

Open

#1,570 opened on Jul 30, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (1,408 stars) (274 forks)batch import
documentationgood first issue

Description

The concept of memory pinning is discussed in the “Tasks and threads” section of the documentation (in multitasking.md), but Mem.pin is only shown as part of a larger example. It would nice to have Mem.pin documented in the “CUDA driver” section (driver.md) alongside alloc, register, advise, etc. A doc string would be nice too.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Julia basicsCUDA.jl internalsDoc string conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing documentation in `docs/src/usage/multitasking.md` to understand the current context of memory pinning. Then look at `docs/src/usage/driver.md` to see how other memory functions like `alloc`, `register`, `advise` are documented. Also review the source code of `Mem.pin` (likely in `src/memory.jl` or similar) to write an accurate doc string. Follow the existing doc style in the package.