From mboxrd@z Thu Jan 1 00:00:00 1970 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B3C22C43334 for ; Mon, 11 Jul 2022 20:26:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231617AbiGKU0L (ORCPT ); Mon, 11 Jul 2022 16:26:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44536 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229622AbiGKUZ3 (ORCPT ); Mon, 11 Jul 2022 16:25:29 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 678354A804 for ; Mon, 11 Jul 2022 13:25:26 -0700 (PDT) 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 561D061642 for ; Mon, 11 Jul 2022 20:25:25 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id DA016C341C8; Mon, 11 Jul 2022 20:25:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1657571124; bh=o2iriqr9yGWd6meVOtOwBCMeiBhrD3lI1NVS6cm0Kmc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=YLT6S5V3wpeb0ALSjTIoMWeqhQ6ejsrrlvZ8WVJT5r4tJ5Rl9d+N9pV1TnMFigJ4B vt9x8lHKg4dzcpkz4jc/moK8YEp4XfBi6eN0VtE31STGN92PCC6j2rlCBnhnmVuk83 hrpRdNe8fuKgDpfBL5YmNOW1+IXpACRU6BZju0rYBAvQXrp8u3+JSyjMfSE0sX7MtU dvru0K5hMWY1dHb6LaZrjg1YYYSbIsdW1kn7lFIUvxky1XWgQDZOa8aHCqn0zmW3JQ gfnXqGPII7fIyACS/9x5VFyVFU1YZ+kin5r4tiJ/tbkL1Mpnk4m6NK99C7AHo6NVzE 8f+CMKKIiANWQ== Received: from mchehab by mail.kernel.org with local (Exim 4.95) (envelope-from ) id 1oAzy3-004e8F-Kg; Mon, 11 Jul 2022 21:25:19 +0100 From: Mauro Carvalho Chehab Cc: Mauro Carvalho Chehab , "Jani Nikula" , "Lucas De Marchi" , "Rodrigo Vivi" , =?UTF-8?q?Thomas=20Hellstr=C3=B6m?= , Daniel Vetter , David Airlie , Joonas Lahtinen , Matthew Auld , Nirmoy Das , Tvrtko Ursulin , dri-devel@lists.freedesktop.org, intel-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org Subject: [PATCH 16/32] drm/i915: i915_gem_region.h: fix i915_gem_apply_to_region_ops doc Date: Mon, 11 Jul 2022 21:25:01 +0100 Message-Id: X-Mailer: git-send-email 2.36.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit To: unlisted-recipients:; (no To-header on input) Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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. 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 00/32] at: https://lore.kernel.org/all/cover.1657565224.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 -- 2.36.1