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: <5372b154-dc25-a917-9908-c59555afc865@amd.com>
Date:   Wed, 14 Sep 2022 10:24:36 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH] 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: <YyGuwqpuwq+PT3K1@autolfshost>
From:   Andrey Grodzovsky <andrey.grodzovsky@amd.com>
In-Reply-To: <YyGuwqpuwq+PT3K1@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?R0pDOTVlS2MxVHpiWHVKMjhyMmlSb2dNVThTQldyU3pOdnJvbUp1UzVESm5j?=
 =?utf-8?B?Y09tbjVla0gvbXBnbGM5aVFUQ21DaGJVeXp5NjU1L0xuK1BzQTZ5WVM4aEdP?=
 =?utf-8?B?UjN3YjlIK3IwbE0yK1crYTBDVzhZWlRFYlFwc0JVV2NZNFJOOWU3TFpWUWcz?=
 =?utf-8?B?Q0ZleVUvemlHYTBqZUl5YTdOTjBzQkZTQ3J2Z2Jsb0JlaWVJZmxza2RYamFh?=
 =?utf-8?B?Q1JpN2RCMVcyaUFtb2F4NDBwUmY3U21UTkdCc2lWa1kzdVM2U1VrY1lYZFFN?=
 =?utf-8?B?ZHRVajZZa0hLS05VRkFFc0VMRHZxNGNzZTBmbmNNRmdERGdEb3Q1cHB0TnAz?=
 =?utf-8?B?bjFHZThpUVJuTlFSNGdUU3lUZkx5TzErSmk5eHlrdTF3aitlSGpkU2JjUng5?=
 =?utf-8?B?djNwcjgxa3lvcWJZN29NL1hDVzgrMVIySWpxSVdTT3FNVysvcnF0M3Y1QVo5?=
 =?utf-8?B?RFpaQnVWdVZoSjR2VUF1dkd5RTEveDgxZVZoUitlK3JQckxrWWhDeFQ4WnYw?=
 =?utf-8?B?KzNIMEhsdE4wTHNXeFlMNDVYN1JJM0MxUng4RzcweGRUNGd6bVBUd2J4Y3Ir?=
 =?utf-8?B?d0FhYmVXZ3RXa2ExNjh6T3NPU0FNR0xUOEl6SVgzSjVMZDZqb0Z1N09JUFZ1?=
 =?utf-8?B?V3MyQ0ZCYlh5M2NxdzJNQSt5Nk1mMnZHWldBY0hIWHVvZmdDY0xlckZWK2hs?=
 =?utf-8?B?U2JIU3pNYmRGWkV5N2tXaFQraGZkV0ovUGxvajlRUmJrTkc4QVBKdnVIUHMx?=
 =?utf-8?B?UFk1Tzk1ZUhSUjdkQjdJM3dGUFo1SVQrWjl2N0VBTGdXRzF2alU5eGJtdDJM?=
 =?utf-8?B?OVNvL2EwQSswYjNmeHR3dTdsTVdZTlFPVlFSdmlOb2FCOTRSOXp4QWdPS0VO?=
 =?utf-8?B?UXhONzZNdWRNU2RWc3o2ak1tT1V4dXY2dGIyb0l3VGRPSDVQNUs5dTd6YVpr?=
 =?utf-8?B?citTbjFXckpnQ211QUp3SFZyYVU3a0Z1SUZmdzBUa28zdE1rQklpdGxZSnVU?=
 =?utf-8?B?UHl0Q1Z1bnZESTRFSmV5ZnZhWmpzN2p4RkdVb0wxWVhxVGNvUmJ0Sk5XY2tW?=
 =?utf-8?B?Tm5abVdmZ2NDR2U0cUlxRk5uOGlIVkRLK2Q5MUJTL0F4VGtCUXJrZUhOUFhW?=
 =?utf-8?B?b2VQMTcwcVFzd2ZzWFcwbmRxNXp4eUtjRU92b0xJK0VSUFQ3QkZzOUZvNkhZ?=
 =?utf-8?B?Y3crTFlSWHQxTmtNS1FuUHlDWVlKWHVWaUtSQVM2cE1jTHBLOWdIWmF3QUF2?=
 =?utf-8?B?eCtxTkhuQ2tRNzQ2UElEYlE3RzFhMjFpckFXWWNmS2c5RGEySCtQeS9uZGJU?=
 =?utf-8?B?aGJQQ0x6N28zQ2NSRG5RV3JBS1ZLM3FzZ0dmRm84WUU4TGdZUWhPYlRrWEZR?=
 =?utf-8?B?WXhBZmNuZC9mcUhKbW1tcURNbmh4bjhBTWVxMVgxVHMzQUVOMEtuWGdnZ0pE?=
 =?utf-8?B?TGJCQyt5WGNMaTRqSlFCK2NsSWV3OW5WMmpoNWN1QnNQK0RIUlZJaGErMGFG?=
 =?utf-8?B?THhUY0tadEU5MXgyelZqZGZDTFB1RVBhVEphVVFZZks0a1pENDF4ZkRrcmZ1?=
 =?utf-8?B?U0tkWUo5VFpYVDdqT2ZDeVdJQ0drSEJ2YjFqU0UyWEwzRzBKaU5jMDdqSDJN?=
 =?utf-8?B?MmJyUVd5RVBYdGFSS2toTEgrM0ZFQ2tyb01LVW1aMi9NRmtjU1NVdEsrWk1t?=
 =?utf-8?B?Qnk0N1lmMVJ3Z3lUcW51T3lvOGVTUFJqb3hoeTdKTHBwbUlZenpKN3ltNm5P?=
 =?utf-8?B?b29yN0ZjbjRmNFZxemhacGFQWEhFei9yMDJnd3R3VWxxbEVCNEVNbDhWQnlO?=
 =?utf-8?B?U29TS29EeG5IOHBNNGFmbndzSmtoVnp6ZHRyUmV5d2U4NFk3RUpleWV6TjND?=
 =?utf-8?B?ZW02VFU2NGU0bVFWaXR5M016L1N0ZFVlanpqQmw2ODdUY2hmT1AxZXJaM1h2?=
 =?utf-8?B?MjJBd3BkNVpaN2FhZWx5Q0RlN29WZEVDUlpJNWhCaCtWZW5Dc1h0ZjdVRWxi?=
 =?utf-8?B?akVqTGVJSVAzcGFTOEFBZExIZVROdDUwVm1ReHpmRlY3cjh5cEtWY0xGVUhP?=
 =?utf-8?B?c2NpNzd0NjBTL0FoZ2Zpb0RseWtXL2NEVjM4NlpTVVZJZFRlNVB6QUM4NDEy?=
 =?utf-8?B?WFUvRU1rYlpkZjhtbmJpNWVhR1lYZE85SEUvMUFxUWtLaklLcCtZNVBqVTJl?=
 =?utf-8?Q?yYRRadX9+QsySnRWjJhHQMJF/+Cc7yAL5YkCSpGcHNlw?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8246b6cf-06c1-4cde-919e-08da965cdb4e
X-MS-Exchange-CrossTenant-AuthSource: CY4PR12MB1943.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Sep 2022 14:24:39.5768
 (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: S5R8MfDIvqeDy5zo00GD1YvNYvojQInzmNPJSGRJaZAEC6A654CM1ClYmKaE89AFcC39hJaXJ3tGbXpC5kdMLQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR12MB6919
X-Spam-Status: No, score=-3.7 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,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 2022-09-14 06:36, 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>
> ---
>   drivers/gpu/drm/scheduler/sched_main.c | 1 +
>   include/drm/gpu_scheduler.h            | 1 +
>   2 files changed, 2 insertions(+)
>
> diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
> index 68317d3a7a27..875d00213849 100644
> --- a/drivers/gpu/drm/scheduler/sched_main.c
> +++ b/drivers/gpu/drm/scheduler/sched_main.c
> @@ -994,6 +994,7 @@ 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 for use in error reporting in a multiple GPU scenario.


Why multiple GPUs scenario ? It's also used in single GPU scenario.

Andrey


>    *
>    * Return 0 on success, otherwise error code.
>    */
> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> index addb135eeea6..920b91fd1719 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -435,6 +435,7 @@ 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 for use in error reporting in a multiple GPU scenario.
>    *
>    * One scheduler is implemented for each hardware ring.
>    */