From ed3e035773ed2b233bc3d6b7a509b6cb1b7db7ca Mon Sep 17 00:00:00 2001 From: stefan11111 Date: Sun, 28 Dec 2025 00:24:49 +0200 Subject: [PATCH] gbm: Make documentation for `gbm_bo_map` more explicit Reviewed-by: Simon Ser Signed-off-by: stefan11111 Part-of: --- src/gbm/main/gbm.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/gbm/main/gbm.c b/src/gbm/main/gbm.c index 599f7aae9b6..9b7b1ccc045 100644 --- a/src/gbm/main/gbm.c +++ b/src/gbm/main/gbm.c @@ -603,10 +603,11 @@ gbm_bo_import(struct gbm_device *gbm, * \param height The height of the mapped region for the buffer * \param flags The union of the GBM_BO_TRANSFER_* flags for this buffer * \param stride Ptr for returned stride in bytes of the mapped region - * \param map_data Returned opaque ptr for the mapped region + * \param map_data Returned opaque ptr for the mapped region that should + * be passed to gbm_bo_unmap() when the mapped buffer is no longer needed. + * *map_data must be a %NULL pointer. * - * \return Address of the mapped buffer that should be unmapped with - * gbm_bo_unmap() when no longer needed. On error, %NULL is returned + * \return Address of the mapped buffer. On error, %NULL is returned * and errno is set. * * \sa enum gbm_bo_transfer_flags for the list of flags