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;
Message-ID: <52c849ad-2645-03c8-4907-07df6b2fc090@amd.com>
Date:   Tue, 20 Sep 2022 13:07:04 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH v2] A simple doc fix
Content-Language: en-US
To:     Anup K Parikh <parikhanupk.foss@gmail.com>,
        skhan@linuxfoundation.org, airlied@linux.ie, daniel@ffwll.ch
Cc:     dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
References: <Yylh1Nst25I6u6Uh@autolfshost>
From:   Andrey Grodzovsky <andrey.grodzovsky@amd.com>
In-Reply-To: <Yylh1Nst25I6u6Uh@autolfshost>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?eDFZTGFPVEx3aWFKZXBPQmJjZHJIdjFnTnRtZk9rbVFKdDU2MjRMY0Q4Q3Nx?=
 =?utf-8?B?RnlRQ09LaVc2U0FlU3VETUMwZWh0WHVoNVV0bHo0Zm9rWWVBKzR4TGxQK1lR?=
 =?utf-8?B?Q0ozd3hIaTUvMVMvWEx4MEl1SHN5N1ZmZ3FuY1RoN0FaajdCclhlcWtBMS91?=
 =?utf-8?B?NTdScGxsTm8vZ2tHVUlOUi9MRGRFQ1ZvRGtPWHROZi8xQUJ2U0FzNjRKajdW?=
 =?utf-8?B?cncvb1FXSXhrSHYrVWN1Yi9OUkhRUjl0RFM3aGYzOUc4dEx1S3pFUEkrV2dk?=
 =?utf-8?B?N3o5dHpIUVZ3WGpJVGhtN1U5VFJYVzlwY0tsUG8wYUJVQ2pjTUgrcExlbTl6?=
 =?utf-8?B?VFl3L2NoNnhZOUhkMlhRRXdZamY4RkhTcFduS2QyV3NhQmE4ZjNpQmNMTG5q?=
 =?utf-8?B?WS9VTXU0aHJpNFBpTGkvRkNiUE9uWS9XRElybW8zQnVKL1BKb3BHVENoRDhL?=
 =?utf-8?B?RVcxZnJlSVF3eTdpeUJoM041TzlQZnp6K0YyNnZRczRxaWhiM1phdGJadWtJ?=
 =?utf-8?B?RHhwanc0b2x3d0xnRFBKbE1GWG5oOFc3SGQ0dFpKYVZIWStUODV5bW9JUmpP?=
 =?utf-8?B?cWsrckpuU3VHalN2b0VJY21OMTFsRFlEQTBJcWxGM2QreHpLVTY4eEpkT0Yx?=
 =?utf-8?B?NG9tWXgweUxocnF0WVFmUkdaWHdHZjFxUWpVNVM5YWJsYnRYbWVhVTZHVUh2?=
 =?utf-8?B?Q0pMY3dDYklxUEorRUMzS0hTM3lVbXJ3TnV6QVl1bkN5T2lOVVdjUDc3WWdK?=
 =?utf-8?B?ZFA0QlhVbU5vSmVHUVNhQjM5WCtlbnhBeUNpQ2kxN0xaNDFueVgrQ3hTSDVT?=
 =?utf-8?B?bXFvMjZpSUZRMG9uTEJMaExNL0J4M1VCNzJBSXBIdDlVVUZ5VWtoelJKVkVL?=
 =?utf-8?B?OVRqM1I3bGJDZ2lma3BLNHl2MTdqSzJnbWVJczl0ZnBGV0xPNlNuU3NJbmlN?=
 =?utf-8?B?cFhZYXlxRExRYmJ1Yjg0Uk1EK2tqV2ZrYkNRd2ZEdXkvQ25BNUdGR0p5Uk9T?=
 =?utf-8?B?SzcySGJIRlRxeDlPczNWTWN1QjZaU0I1T0d3dXlTUitUTDBycVZIbHg3WUUy?=
 =?utf-8?B?LzU3SzdYWkFUcG9TUUErYTJNa0VIY2xDS2MxOEFwK3Q0QXV5YjJPQzNnRE1n?=
 =?utf-8?B?NWxIMmdpZGZUMjBOUUNHcEhXZndYQ1d4U05aM3lvdmVPa3VVUmhLN2FDVUM2?=
 =?utf-8?B?NnpWUjlNRWQ0MHg1SWxuc044NVBtbUxiaGdRcytzWnBldGQya2NrZEpGWWlK?=
 =?utf-8?B?cGR6amNSNFJlakpnRWdSdFh3WXFSVFRGd0c2Q1ZnMEVRQnAySWlEK2pIZ3BO?=
 =?utf-8?B?RXNCRjFYVHV5aGZBUVl5dEhIcDNmUkNpN2EySGVqQ1VvWDk2NGlmczZVK2hO?=
 =?utf-8?B?NXRLNEZ2VXpJYnpOWXhFTndtWklCY3crcFJhODJUcnd2bUxvL1lubnN2aXAz?=
 =?utf-8?B?TFU0UEp3K2lhZkJTTnRJbDJQWENjM2txdTRWRmovN25PRmE3L1FNMXpxU2FB?=
 =?utf-8?B?MjRRQk53MEo0ZUt2dnIrNWhLOUtXWmJjd2pLeWJpS3pkZ3k4dGlVdGJDZlZw?=
 =?utf-8?B?UHU4aSt2UHRRdFdHMEVQTk5GYThJMmppeE1VVXRtKzB6UDJMZVlEcGhuaEFK?=
 =?utf-8?B?TlNSblV2eUJxRXpYeUFmcktkaFBTYklZMlQ4U242ejVPanJ3ang0NlFmV0VI?=
 =?utf-8?B?Z0FINGs3cEo5QXp5M0xZR2N5OVRUSXZUVjJ4N3BOS1QvWWhsd1NvdFZOeG9U?=
 =?utf-8?B?WFk3SmVRVEZpa0k0TXIrcHlXQUNNVGEyTFhlM3ZFdG83d1ZPMWN0MURZWk9Y?=
 =?utf-8?B?ZTJJUWFEWVdtMGtMa3J5Rkh3MHo1d1o4amgxakRmUmxOTENlbXI5RkFUbk5l?=
 =?utf-8?B?WkFXWXBpZ1ZGak9OekN0M3Qyb2FNaU9BY2l0VDBEYXdIN2J2UHZMNnZtMFU0?=
 =?utf-8?B?Z04rby93SGNNU2FYdEJtL0hEUkl2RUsvV3Z1S3dKN0s0ZHdlOFpacXE0eHRL?=
 =?utf-8?B?RkxXR2ZyL0l1cnNBdGpZbWJiSzBVcGdVUm1ETGhYNHZUWDlxWlJxRncvSVk0?=
 =?utf-8?B?cUVLL1NTWW1YRnZLMVBFaW4xVkMwMmxVTS9SekpJK1E2UHB5alJpUnUwRTBv?=
 =?utf-8?B?ZUhKU1BHQzRhSzNaVmYwS3pMRzhPM2xaOHNaRGpjWjlwMmRPQWJTYmd3amZy?=
 =?utf-8?Q?Hoy9rhIruTVj9fQlCr/fn3c+AaJ2JEqwNkxgbOkL9IT7?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a52713d2-51b9-47dc-6de9-08da9b2a8baa
X-MS-Exchange-CrossTenant-AuthSource: DM5PR12MB1947.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Sep 2022 17:07:06.1886
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: XZ44CoZdvWBd00b7k8LzwjNgUHROVAipUESeJSxrVhY9R583RvT2WQxH4+YoVzOaYghNg7KDCHipxae4+1igDQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR12MB5418
X-Spam-Status: No, score=-4.3 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS 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

After rebasing to latest drm-misc-next to latest I actually see someone 
else already fixed this and other kerneldoc warnings so we can skip this 
patch.

Andrey

On 2022-09-20 02:46, Anup K Parikh wrote:
> Fix two warnings during doc build which also results in corresponding
> additions in generated docs
>
> Warnings Fixed:
> 1. include/drm/gpu_scheduler.h:462: warning: Function parameter or member
>     'dev' not described in 'drm_gpu_scheduler'
> 2. drivers/gpu/drm/scheduler/sched_main.c:1005: warning: Function
>     parameter or member 'dev' not described in 'drm_sched_init'
>
> Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
> ---
> Changes in v2:
>      Correct the doc strings according to
>      Link: https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.kernel.org%2Fall%2Ff528a8e4-5162-66d5-09da-5252076882b8%40amd.com%2F&amp;data=05%7C01%7Candrey.grodzovsky%40amd.com%7Ccbef53d3f32845465ce908da9ad3f29b%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C637992532358603366%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=PnHCvtDFVWnb25YkDfjHcmy9MBpLCA462xco799rjJs%3D&amp;reserved=0
>   drivers/gpu/drm/scheduler/sched_main.c | 2 ++
>   include/drm/gpu_scheduler.h            | 2 ++
>   2 files changed, 4 insertions(+)
>
> diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
> index 68317d3a7a27..979685830671 100644
> --- a/drivers/gpu/drm/scheduler/sched_main.c
> +++ b/drivers/gpu/drm/scheduler/sched_main.c
> @@ -994,6 +994,8 @@ static int drm_sched_main(void *param)
>    *		used
>    * @score: optional score atomic shared with other schedulers
>    * @name: name used for debugging
> + * @dev: A device pointer - primarily useful for printing standardized
> + *       messages with DRM_DEV_ERROR().
>    *
>    * Return 0 on success, otherwise error code.
>    */
> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> index addb135eeea6..80a525dd19bd 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -435,6 +435,8 @@ struct drm_sched_backend_ops {
>    * @_score: score used when the driver doesn't provide one
>    * @ready: marks if the underlying HW is ready to work
>    * @free_guilty: A hit to time out handler to free the guilty job.
> + * @dev: A device pointer - primarily useful for printing standardized
> + *       messages with DRM_DEV_ERROR().
>    *
>    * One scheduler is implemented for each hardware ring.
>    */