Messages in this thread | | | Date | Fri, 5 Aug 2022 10:24:25 +0100 | Subject | Re: [PATCH v3 3/3] drm/i915/gt: document TLB cache invalidation functions | From | Tvrtko Ursulin <> |
| |
On 05/08/2022 10:08, Andi Shyti wrote: > Hi Randy, > >>> +/** >>> + * intel_gt_invalidate_tlb_full - do full TLB cache invalidation >>> + * @gt: GT structure >> >> In multiple places (here and below) it would be nice to know what a >> GT structure is. I looked thru multiple C and header files yesterday >> and didn't find any comments about it. >> >> Just saying that @gt is a GT structure isn't very helpful, other >> than making kernel-doc shut up. > > the 'gt' belongs to the drivers/gpu/drm/i915/gt/ subsystem and > it's widely used a throughout i915. > > I think it's inappropriate to describe it just here. On the other > hand I agree that a better documentation is required for the GT > itself where other parts can point to.
Yeah agreed there is no point of copy pasting some explanation all over the place. Could we just do s/GT structure/struct intel_gt/, or "pointer to struct intel_gt to operate on", would that be good enough?
Regards,
Tvrtko
| |