drm/gpusvm: Fix kernel-doc header, parameter, and grammar
Subsystems (3)
PATCH 1/1 drm/gpusvm: Fix kernel-doc header, parameter, and grammar
The kernel-doc for the GPU SVM validation helper has drifted from the actual implementation. Specifically:
1. The function name in the comment refers to a 'range' naming convention not present in the function signature.
2. The second parameter is documented as '@range' instead of '@svm_pages'.
3. The description seems to have some minor grammatical errors.
Update the kernel-doc block to match the implementation and improve readability.
Signed-off-by Jay Winston <[email protected]>
On branch gpusvm-docfix
Changes to be committed:
modified: drivers/gpu/drm/drm_gpusvm.c
--- drivers/gpu/drm/drm_gpusvm.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/gpu/drm/drm_gpusvm.c +4 -4
@@ -1338,12 +1338,12 @@ bool drm_gpusvm_range_pages_valid(struct drm_gpusvm *gpusvm,EXPORT_SYMBOL_GPL (drm_gpusvm_range_pages_valid);/** -* drm_gpusvm_range_pages_valid_unlocked() - GPU SVM range pages valid unlocked +* drm_gpusvm_pages_valid_unlocked() - GPU SVM range pages valid unlocked * @gpusvm: Pointer to the GPU SVM structure -* @range: Pointer to the GPU SVM range structure +* @svm_pages: Pointer to the GPU SVM pages structure * -* This function determines if a GPU SVM range pages are valid. Expected be -* called without holding gpusvm->notifier_lock. +* This function determines if a GPU SVM range of pages is valid. Expected to +* be called without holding gpusvm->notifier_lock. * * Return: True if GPU SVM range has valid pages, False otherwise */
Signature · 1 line
2.46.4