Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 9 Aug 2022 05:59:44 -0400
From:   Rodrigo Vivi <rodrigo.vivi@intel.com>
To:     Mauro Carvalho Chehab <mchehab@kernel.org>
CC:     Thomas =?iso-8859-1?Q?Hellstr=F6m?= 
        <thomas.hellstrom@linux.intel.com>,
        David Airlie <airlied@linux.ie>,
        <dri-devel@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>,
        Matthew Auld <matthew.auld@intel.com>,
        <intel-gfx@lists.freedesktop.org>
Subject: Re: [Intel-gfx] [PATCH v2 19/39] drm/i915: i915_gem_region.h: fix
 i915_gem_apply_to_region_ops doc
Message-ID: <YvIwEIfinUclVQN+@intel.com>
References: <cover.1657699522.git.mchehab@kernel.org>
 <f197e0eccbde017dccbd31e72c892a102543cb90.1657699522.git.mchehab@kernel.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <f197e0eccbde017dccbd31e72c892a102543cb90.1657699522.git.mchehab@kernel.org>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?kdO5PSsyYtl+cWw+N1uX9v7r05kEFa8fbrpCnfAeGhsIA3YtK3n2LIaPjRc0?=
 =?us-ascii?Q?ngHjmDm0vtJ56fw1U0G9bLqJOHlvgN8MB3yz0XW6pNQjhHBqVglwfhpau4rQ?=
 =?us-ascii?Q?ciYWXEwmHfrTDnnvPRLuDGvWVYszEjwz3YB14KWy3ckrqY5qFm3MocQVugLK?=
 =?us-ascii?Q?3QtIc+8ckvc34glWf16NMY/lFQuM0PGCCPpYIAUNN5yBEiHo9JvT/pdcCgLD?=
 =?us-ascii?Q?FZ44+0P2L1h9aIGr0FoBIOdIxSsfNvbZE5qDcmmtR571isA/6C77uu6uqz+G?=
 =?us-ascii?Q?UAgS46S5hrwzGKHG1wj69e3A9dFBCc8CkjeGvnaY+LGm/wEcfSFPjhGny6wT?=
 =?us-ascii?Q?O2NrwI7cewei+Gi5NL9YLe02lMLOsWf/uWVdHu3KuzDVXKfYIPtznEWJXxw0?=
 =?us-ascii?Q?Fel3e+2ue4P5bTEweo6jLDt63cqKaRfd/v82EZ0t5XJnNlTIWr8urIqiLNEi?=
 =?us-ascii?Q?OxGrGCwOUIoVotNs+Q2vi6SvaC8exi4hnTM1ANy0cLKWH/RO9NmHIktUVbxy?=
 =?us-ascii?Q?OtJmiSvwtM1/iiPreubfyx9DRUJNksy3eC6GMvUsNpe8Z+1a8vu8qk3z0oyb?=
 =?us-ascii?Q?DOMVwgEWqNLaPyG0O2YrTp/yD+5aHvO1sssCxnqmJUTX75m17RF9ihrG4qNq?=
 =?us-ascii?Q?/qAGyQNavK8znh7p1yokFDsZuMnarYWiLHCGcxG5tGau6qqiCxEegfzI4spQ?=
 =?us-ascii?Q?HspeOTA9zZdHbFN3mZtbiBDoC5mEZUTmas2d6RKuJ+O9DJGC4d90ClOV5bJe?=
 =?us-ascii?Q?Bk2NTUvTtbaHUlUjNULs6mKwsyV47ldxI5ScoNqC/gvkWsQQN9mh62JiwGnD?=
 =?us-ascii?Q?urMikzKT4SuJp64GXLU8Wht0CXCpEwIQ0JR9FaapzgBlFfnzQQ4XZ6ofucco?=
 =?us-ascii?Q?iPVGbouH19b0k9GR+MnN/0ejWlBNWZ2KGXz23YXkvklLiFQE3dw3NHmEe7Go?=
 =?us-ascii?Q?OSLRRKj8faEdaAI7Bzz/VY7usDb+u1aJ86vjM1vvMLfae0w6q/tV2wdPOiyg?=
 =?us-ascii?Q?kdZyATDkYXPwPubwNMAIn3+w4FCvEtkj4kctd0hskTmgK+vuvJweq8+MYudH?=
 =?us-ascii?Q?WYwjr4Mk3ZZj6HmK+j5XhBPcsHWyz6q96ggabZYMrz0Q/cY0oPIjJ5+BdGUI?=
 =?us-ascii?Q?t1qMMKjv1MIksLwDbSOAwnj0916cSE/MY9yvjP5haZOlabshiU3k9NxbNOZM?=
 =?us-ascii?Q?eNweZ62+3wynZ3P7yG4Oixjg9afcZtWO0OZf/t4P0VqA3DX56XlTUYF5X/67?=
 =?us-ascii?Q?Rrpw1CtBVGZruRI7NSgyQ5WNPHLfOPxZxkEFIV73Py3TtQFW2iTsTCP9qWTy?=
 =?us-ascii?Q?WmzwTNlxPDz6ifZitSnI/F0P8e1KgbpbV8vQtpQK8apGsD9S8E+OVtp0yZNf?=
 =?us-ascii?Q?Bkoa6EHAVaHj0Jv2B6TV1Cj6Ojuidm0goOivW9/ccG/j5+tMBkIkj8+dE4tS?=
 =?us-ascii?Q?TH5s0+Rk/vblsyoG/jtHPHvg3siqitsYWcd6zPwWuPKsBvrjk7pJNgGSOwfy?=
 =?us-ascii?Q?hndMBOmvTBg8L3y9brzefL+V4BDeGB/Cv2mszmxi3UYfQyPvN02ezLI32hhJ?=
 =?us-ascii?Q?AyUmWKsdA3oE0E8PdcrB6JLU1wgjXjbxowgqqFXu2oN7rcbc5gQzE+Be8CWw?=
 =?us-ascii?Q?Ig=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 7e32556d-581b-4bcd-79fd-08da79ede571
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Aug 2022 09:59:49.2956
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: gSAX1VN/W2WoBcOqKXrnpDcqcGDv+lxUcpRvRMaQmRqd4tbwNCgKcQG4IgY1jiomeio9iI8eTT8+HrdxvL+fdg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB4958
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-5.0 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,
        SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Wed, Jul 13, 2022 at 09:12:07AM +0100, Mauro Carvalho Chehab wrote:
> 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 <mchehab@kernel.org>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.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
>