[Intel-gfx] [PATCH] drm/i915: Correct the docs for intel_engine_cmd_parser

[Rodrigo Vivi]

On Tue, Jul 20, 2021 at 04:25:21PM -0400, Rodrigo Vivi wrote:
> On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> > In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
> > cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> > without updating the docs, causing Fi.CI.DOCS to start failing.
> > 
> > Signed-off-by: Jason Ekstrand <jason at jlekstrand.net>
> > ---
> >  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
> >  1 file changed, 1 insertion(+), 3 deletions(-)
> > 
> > diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > index 322f4d5955a4f..e0403ce9ce692 100644
> > --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> > +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
> >   * @batch_offset: byte offset in the batch at which execution starts
> >   * @batch_length: length of the commands in batch_obj
> >   * @shadow: validated copy of the batch buffer in question
> > - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> > - * @shadow_map: mapping to @shadow vma
> > - * @batch_map: mapping to @batch vma
> > + * @trampoline: true if we need to trampoline into privileged execution
> 
> I was wondering if we should also return the original text, but this one
> here looks better.
> 
> 
> Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>

btw, while on it, I wouldn't mind if you squash some english fixes to
the trampoline documentation block inside this function ;)

> 
> 
> >   *
> >   * Parses the specified batch buffer looking for privilege violations as
> >   * described in the overview.
> > -- 
> > 2.31.1
> > 
> > _______________________________________________
> > Intel-gfx mailing list
> > Intel-gfx at lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/intel-gfx