From patchwork Fri Sep 9 07:34:23 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 12971173 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id ABACCECAAD5 for ; Fri, 9 Sep 2022 07:38:05 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 3A77910EC3C; Fri, 9 Sep 2022 07:35:52 +0000 (UTC) Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by gabe.freedesktop.org (Postfix) with ESMTPS id CD35E10EBF0; Fri, 9 Sep 2022 07:34:58 +0000 (UTC) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 11A1261EFE; Fri, 9 Sep 2022 07:34:56 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 6D613C4315B; Fri, 9 Sep 2022 07:34:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1662708894; bh=S4bANEeHKbCIucHL0b1oo2+G+DOuxAxKF0gbAf9tZHI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=cAZdv7BpxnEPXAwSo3XQteC0pNH1UuWO8bf7e39CezfybXG8k68p22zQcJD8srddE KJchUpVseC/YSHSbCUlUDPzxtGq6OL1iRyRDrBFlNfGr/IaLaxpJlCTSJVAZMuGq4X WbZBIpi8/jl4K0chZT3LUXzMuwIibOlked5sg+pxIb3tI97oknsm5fD3hxtSW7fqkr jyPCjHAIoY5nZo0cZMOuQsEmzbLZvN5h3Udoub4GHrIEWFNfCL8Wf4o9wT8410YoYj 2LwvWPH7r7FOUpR2VluTl4vfRbUHbXFreSJRgsdGuan24Y8ynWRM0bxTR4iBoS7/I6 XDbVwWhokDjDA== Received: from mchehab by mail.kernel.org with local (Exim 4.95) (envelope-from ) id 1oWYXG-007FGd-Eo; Fri, 09 Sep 2022 09:34:46 +0200 From: Mauro Carvalho Chehab To: Date: Fri, 9 Sep 2022 09:34:23 +0200 Message-Id: <3dd5f96491ae18b29fccc4c27b0951dff7539ed8.1662708705.git.mchehab@kernel.org> X-Mailer: git-send-email 2.37.3 In-Reply-To: References: MIME-Version: 1.0 Subject: [Intel-gfx] [PATCH v3 16/37] drm/i915: i915_gem_region.h: fix i915_gem_apply_to_region_ops doc X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?utf-8?q?Thomas_Hellstr=C3=B6m?= , David Airlie , dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org, Matthew Auld , Daniel Vetter , Rodrigo Vivi , Mauro Carvalho Chehab , intel-gfx@lists.freedesktop.org Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" The kernel-doc markup for i915_gem_apply_to_region_ops() has some issues: 1. The field should be marked as @process_obj; 2. The callback parameters aren't document properly, as sphinx will consider them to be placed at the wrong place. Fix (1) and change the way the parameters are described, using a list, in order for it to be properly parsed during documentation build time. Reviewed-by: Rodrigo Vivi Signed-off-by: Mauro Carvalho Chehab --- To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/37] at: https://lore.kernel.org/all/cover.1662708705.git.mchehab@kernel.org/ drivers/gpu/drm/i915/gem/i915_gem_region.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/drivers/gpu/drm/i915/gem/i915_gem_region.h b/drivers/gpu/drm/i915/gem/i915_gem_region.h index 2dfcc41c0170..b0134bf4b1b7 100644 --- a/drivers/gpu/drm/i915/gem/i915_gem_region.h +++ b/drivers/gpu/drm/i915/gem/i915_gem_region.h @@ -22,9 +22,11 @@ struct i915_gem_apply_to_region; */ struct i915_gem_apply_to_region_ops { /** - * process_obj - Process the current object - * @apply: Embed this for private data. - * @obj: The current object. + * @process_obj: Callback function to process the current object + * it requires two arguments: + * + * - @apply: Embed this for private data. + * - @obj: The current object. * * Note that if this function is part of a ww transaction, and * if returns -EDEADLK for one of the objects, it may be