[PATCH] drm/scheduler: fix param documentation

[Alex Deucher]

On Tue, Mar 27, 2018 at 1:29 PM, Nayan Deshmukh
<nayan26deshmukh at gmail.com> wrote:
> On Tue, Mar 27, 2018 at 1:47 PM, Daniel Vetter <daniel at ffwll.ch> wrote:
>> On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote:
>>> Signed-off-by: Nayan Deshmukh <nayan26deshmukh at 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.

FWIW, I started improving the documentation in the GPU scheduler last
week, but ran out of time to finish it.  Here's the WIP patch. Feel
free to run with it.

Alex

>
> 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 at lists.freedesktop.org
>>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
>>
>> --
>> Daniel Vetter
>> Software Engineer, Intel Corporation
>> http://blog.ffwll.ch
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-XXX-wip-gpu-scheduler-documentation.patch
Type: text/x-patch
Size: 10685 bytes
Desc: not available
URL: <https://lists.freedesktop.org/archives/dri-devel/attachments/20180329/a97f2c38/attachment-0001.bin>