diff mbox

drm/scheduler: fix param documentation

Message ID 20180326152114.24948-1-nayan26deshmukh@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Nayan Deshmukh March 26, 2018, 3:21 p.m. UTC
Signed-off-by: Nayan Deshmukh <nayan26deshmukh@gmail.com>
---
 drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Christian König March 26, 2018, 4:57 p.m. UTC | #1
A bit more commit message would be nice to have, like "There is no more 
@kernel parameter and document the new @guilty parameter".

Am 26.03.2018 um 17:21 schrieb Nayan Deshmukh:
> Signed-off-by: Nayan Deshmukh <nayan26deshmukh@gmail.com>

With the commit message fixed the patch is Reviewed-by: Christian König 
<christian.koenig@amd.com>.

Christian.

> ---
>   drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c
> index 0d95888ccc3e..1d368bc66ac2 100644
> --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c
> +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c
> @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq)
>    * @sched	The pointer to the scheduler
>    * @entity	The pointer to a valid drm_sched_entity
>    * @rq		The run queue this entity belongs
> - * @kernel	If this is an entity for the kernel
>    * @jobs	The max number of jobs in the job queue
> + * @guilty      atomic_t set to 1 when a job on this queue
> + *              is found to be guilty causing a timeout
>    *
>    * return 0 if succeed. negative error code on failure
>   */
Daniel Vetter March 27, 2018, 8:17 a.m. UTC | #2
On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote:
> Signed-off-by: Nayan Deshmukh <nayan26deshmukh@gmail.com>

You might want to add a kerneldoc page in Documentation/gpu/scheduler.rst,
which pulls in all the nice kerneldoc you have here + has a short intro
text what this is all about.

Cheers, Daniel

> ---
>  drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c
> index 0d95888ccc3e..1d368bc66ac2 100644
> --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c
> +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c
> @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq)
>   * @sched	The pointer to the scheduler
>   * @entity	The pointer to a valid drm_sched_entity
>   * @rq		The run queue this entity belongs
> - * @kernel	If this is an entity for the kernel
>   * @jobs	The max number of jobs in the job queue
> + * @guilty      atomic_t set to 1 when a job on this queue
> + *              is found to be guilty causing a timeout
>   *
>   * return 0 if succeed. negative error code on failure
>  */
> -- 
> 2.14.3
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Nayan Deshmukh March 27, 2018, 5:29 p.m. UTC | #3
On Tue, Mar 27, 2018 at 1:47 PM, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote:
>> Signed-off-by: Nayan Deshmukh <nayan26deshmukh@gmail.com>
>
> You might want to add a kerneldoc page in Documentation/gpu/scheduler.rst,
> which pulls in all the nice kerneldoc you have here + has a short intro
> text what this is all about.
>
Yeah Sure. I'll send a patch for this in a while.

Cheers,
Nayan
> Cheers, Daniel
>
>> ---
>>  drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c
>> index 0d95888ccc3e..1d368bc66ac2 100644
>> --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c
>> +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c
>> @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq)
>>   * @sched    The pointer to the scheduler
>>   * @entity   The pointer to a valid drm_sched_entity
>>   * @rq               The run queue this entity belongs
>> - * @kernel   If this is an entity for the kernel
>>   * @jobs     The max number of jobs in the job queue
>> + * @guilty      atomic_t set to 1 when a job on this queue
>> + *              is found to be guilty causing a timeout
>>   *
>>   * return 0 if succeed. negative error code on failure
>>  */
>> --
>> 2.14.3
>>
>> _______________________________________________
>> dri-devel mailing list
>> dri-devel@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
diff mbox

Patch

diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c
index 0d95888ccc3e..1d368bc66ac2 100644
--- a/drivers/gpu/drm/scheduler/gpu_scheduler.c
+++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c
@@ -117,8 +117,9 @@  drm_sched_rq_select_entity(struct drm_sched_rq *rq)
  * @sched	The pointer to the scheduler
  * @entity	The pointer to a valid drm_sched_entity
  * @rq		The run queue this entity belongs
- * @kernel	If this is an entity for the kernel
  * @jobs	The max number of jobs in the job queue
+ * @guilty      atomic_t set to 1 when a job on this queue
+ *              is found to be guilty causing a timeout
  *
  * return 0 if succeed. negative error code on failure
 */