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:   Fri, 15 Jul 2022 17:32:57 -0400
From:   Rodrigo Vivi <rodrigo.vivi@intel.com>
To:     Mauro Carvalho Chehab <mchehab@kernel.org>
CC:     Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>,
        David Airlie <airlied@linux.ie>,
        <intel-gfx@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>,
        <dri-devel@lists.freedesktop.org>
Subject: Re: [PATCH v2 25/39] drm/i915: i915_vma_resource.c: fix some
 kernel-doc markups
Message-ID: <YtHdCTN0Bnztsnqm@intel.com>
References: <cover.1657699522.git.mchehab@kernel.org>
 <a830bd63085178004106069a914e80758e321fcd.1657699522.git.mchehab@kernel.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <a830bd63085178004106069a914e80758e321fcd.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?1frJWlnVyG8GfRPakG3OKnLwdcCDotwhR1Sl4xMGkATu5cD+Rx8IzA1OY2ps?=
 =?us-ascii?Q?18c81tjsf3Ik5txPxS6H00c2LffKApBLPFK2ZuUAxyyfCahq8qmXAsAPSZQx?=
 =?us-ascii?Q?U54nfOmjOAzdBWAu5rljhWNYjoolH/oanIRP2Mto4VcWjXw9STqG19xIVo0F?=
 =?us-ascii?Q?igUiOCXYtbarfYuQDuLZShdKsNbi3m5hyabZN5ZutvPWwKdorXugOSZWxfau?=
 =?us-ascii?Q?GyGQ1/tduZ9TwlebqWfoJeuNJg21T6Nek+IW8h9Z0HmeLQ3ItlC+QhdraP3k?=
 =?us-ascii?Q?OJeNfjeMU4JT/4afviNnYVNSnCQK2ywvG1FfIFXfGTqkYqEM3XzxIeW3eDqP?=
 =?us-ascii?Q?2awUH7a9bYfnzF7GkCi9WjOrcK0ljgXoAziOWP09Dd+5Y5yp6gJGuuijDs2d?=
 =?us-ascii?Q?5fBxL3axlHWaEP0orASC188yHByckmjp9o/MYiU08g4DBiMOlmG5mzVZ2TLh?=
 =?us-ascii?Q?/3vJjOgCIY1Ze1EPY37QHx98I9lKuNlDZfvSfRFJBSAnkJHtesNfcwt6Eync?=
 =?us-ascii?Q?O5OWMVpSaY4iUgf1sjve2CdwFdqfnwYWSKOU/iWSz3ZPD1BN80PexsZhG+7S?=
 =?us-ascii?Q?3LkiMW98n2kyeIFcbMBE7zX5ICCTAvLPB9/wVN43vRj1VDTSbSrqfmLSQVZk?=
 =?us-ascii?Q?u4esDjmP2+g6zXJaJksj+/HodNGBklOySyKAlfx5WC5o5AlFr+dWOO2u1iIm?=
 =?us-ascii?Q?myvb4EBa/2Di9ksfBMg/QDvbMaiQcD8IsYVgad877/LqgH7W+xM6mPPA0OmA?=
 =?us-ascii?Q?t0NZ2UdGnjMtq8k6PydPMtAGmdyKu2oaiuQqVEJa4kO9qUL7ZB4dJIuCV+th?=
 =?us-ascii?Q?TUswekyRqda0y56iJwXYYMkyg5WvQbk++mUf+wZ86FymYZCq+7VD06DzMusS?=
 =?us-ascii?Q?cH1LTUMUKzqwlYuF8iKiNjElfHuQkpI3HGzUPs0rMHej3iy41XsrJZcePMxV?=
 =?us-ascii?Q?Msq7ltAdkESD/xKo81pzJaTKqTxyftox0KdHSd69wCy2QHuJLzrG3IcGaF/p?=
 =?us-ascii?Q?XPrn8Ph5iTqX9sg0WgFaA5041qYMncwDoZwPfVj8BzZ/oAQXEep5LUSA4xz1?=
 =?us-ascii?Q?bR7a5wi+U3h7N79xXKwCi0SHocEDfg7eTEFASuwmjYaGQUFLKd8xoRzfxygn?=
 =?us-ascii?Q?Cio1laA8HZ6N8ZdSlF2LuAaqwu/2F3hcfTSqIDqVzuPyyupXHZE/xPirC/1U?=
 =?us-ascii?Q?D3/KAl6srMonkzFlC0UeMv1ZgFXRQPtmdDc2xFzErTSC+PXxmMJqOWFLfF5A?=
 =?us-ascii?Q?DXs2dEcuR4gvSDhl82c7G8ilxvKkD+L+D5t/hPuQUcVJHHqOn7h4AQdSZNhb?=
 =?us-ascii?Q?vWc/h0ySVqLOtr8pSFz1GZ4a2hMIuLCmG0iR0GjKe67Q4seku/IbWz4eZtic?=
 =?us-ascii?Q?0tZ/FsMa9Cut1Ve0uAq8gA9bzKN/Ip0rfzn2OhvQxzaWh2NaqUqZTbiXKV5c?=
 =?us-ascii?Q?CkcMDL6V+tRTSaHtwW6lChTC7IY/g3/Qst6nPX6AJ1MASrhOIcsGwK+mO5Sl?=
 =?us-ascii?Q?axsjKlufKivDGnQb01ru8lAs1gy3uGnhx7nDgWhncME/40XuPQxlXlIKRtly?=
 =?us-ascii?Q?Q62KC+pQIb54pwjcGpwM/ufAr9+8YlhQ6Qsny6sM09wmNbo4VbHmDG/NMYSn?=
 =?us-ascii?Q?7Q=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 13ccbe47-d27d-4f25-8fb7-08da66a9982b
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Jul 2022 21:33:01.7812
 (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: rsqSI7to/sMVP8j2qLz9pC5TR6fLzhmRDj4Yd0D4/nw1WNxiO+2Ent4nQT8ctAllw4Z6tLCsoRdQt+ttKnjwIg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR11MB4090
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-7.7 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI,
        SPF_HELO_NONE,SPF_NONE 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:13AM +0100, Mauro Carvalho Chehab wrote:
> Building docs currently produces two warnings:
> 
>     Documentation/foo/i915:71: ./drivers/gpu/drm/i915/i915_vma_resource.c:286: WARNING: Inline strong start-string without end-string.
>     Documentation/foo/i915:71: ./drivers/gpu/drm/i915/i915_vma_resource.c:370: WARNING: Inline strong start-string without end-string.
> 
> That's because @foo evaluates into **foo**, and placing anything
> after it without spaces cause Sphinx to warn and do the wrong
> thing.. So, replace them by a different Sphinx-compatible tag.
> 
> 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/i915_vma_resource.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/i915_vma_resource.c b/drivers/gpu/drm/i915/i915_vma_resource.c
> index 27c55027387a..fa5a678018d9 100644
> --- a/drivers/gpu/drm/i915/i915_vma_resource.c
> +++ b/drivers/gpu/drm/i915/i915_vma_resource.c
> @@ -283,7 +283,7 @@ i915_vma_resource_color_adjust_range(struct i915_address_space *vm,
>   *
>   * The function needs to be called with the vm lock held.
>   *
> - * Return: Zero on success, -ERESTARTSYS if interrupted and @intr==true
> + * Return: Zero on success, -ERESTARTSYS if interrupted and ``intr==true``
>   */
>  int i915_vma_resource_bind_dep_sync(struct i915_address_space *vm,
>  				    u64 offset,
> @@ -367,7 +367,7 @@ void i915_vma_resource_bind_dep_sync_all(struct i915_address_space *vm)
>   * this means that during heavy memory pressure, we will sync in this
>   * function.
>   *
> - * Return: Zero on success, -ERESTARTSYS if interrupted and @intr==true
> + * Return: Zero on success, -ERESTARTSYS if interrupted and ``intr==true``
>   */
>  int i915_vma_resource_bind_dep_await(struct i915_address_space *vm,
>  				     struct i915_sw_fence *sw_fence,
> -- 
> 2.36.1
>