Re: [PATCH 6/6] Documentation/gpu: Add DC glossary

From: Rodrigo Siqueira Jordao <rjordrigo@amd.com>
To: ydirson@free.fr, "Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>,
	"Christian König" <christian.koenig@amd.com>,
	"Alex Deucher" <alexander.deucher@amd.com>
Cc: "Mark Yacoub" <markyacoub@chromium.org>,
	"Bhawanpreet Lakha" <bhawanpreet.lakha@amd.com>,
	"nicholas choi" <nicholas.choi@amd.com>,
	"Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
	"Alex Deucher" <alexdeucher@gmail.com>,
	"Simon Ser" <contact@emersion.fr>,
	"Michel Dänzer" <michel@daenzer.net>,
	"Roman Li" <roman.li@amd.com>,
	"amd-gfx list" <amd-gfx@lists.freedesktop.org>,
	"Nicholas Kazlauskas" <nicholas.kazlauskas@amd.com>,
	"Marek Olšák" <marek.olsak@amd.com>,
	"Pekka Paalanen" <ppaalanen@gmail.com>,
	"Aurabindo Pillai" <aurabindo.pillai@amd.com>,
	"Sean Paul" <seanpaul@chromium.org>,
	"Maling list - DRI developers" <dri-devel@lists.freedesktop.org>,
	"Bas Nieuwenhuizen" <bas@basnieuwenhuizen.nl>,
	"Qingqing Zhuo" <qingqing.zhuo@amd.com>,
	"Harry Wentland" <Harry.Wentland@amd.com>,
	"Roman Gilg" <subdiff@gmail.com>
Subject: Re: [PATCH 6/6] Documentation/gpu: Add DC glossary
Date: Tue, 30 Nov 2021 10:53:55 -0500	[thread overview]
Message-ID: <3bfcb46a-6d7c-fb11-4b78-d068a620baa3@amd.com> (raw)
In-Reply-To: <1254252919.1503545635.1638218918877.JavaMail.root@zimbra39-e7>

On 2021-11-29 3:48 p.m., ydirson@free.fr wrote:
> Hi Rodrigo,
> 
> That will really be helpful!
> 
> I know drawing the line is a difficult problem (and can even make things
> harder when searching), but maybe it would make sense to keep generic
> acronyms not specific to amdgpu in a separate list.  I bet a number of
> them would be useful in the scope of other drm drivers (e.g. CRTC, DCC,
> MST), and some are not restricted to the drm subsystem at all (e.g. FEC,
> LUT), but still have value as not necessarily easy to look up.
> 
> Maybe "DC glossary" should just be "Glossary", since quite some entries
> help to read adm/amdgpu/ too.  Which brings me to the result of my recent
> searches as suggested entries:
> 
>   KIQ (Kernel Interface Queue), MQD (memory queue descriptor), HQD (hardware
>   queue descriptor), EOP (still no clue :)
> 
> Maybe some more specific ones just to be spelled out in clear where they
> are used ?  KCQ (compute queue?), KGQ (gfx queue?)
> 
> More suggestions inlined.
> 
> Best regards,
> 

Hi all,

I'll address all the highlighted problems in the V2. Thanks a lot for 
all the feedback.

Yann,
For the generic acronyms, how about keeping it in this patch for now? 
After it gets merged, I can prepare a new documentation patch that 
creates a glossary for DRM where I move the generic acronyms to the DRM 
documentation. I prefer this approach to keep the improvement small and 
manageable.

Best Regards
Siqueira