----- Mail original ----- > De: "Rodrigo Siqueira Jordao" <rjordrigo@xxxxxxx> > À: ydirson@xxxxxxx, "Rodrigo Siqueira" <Rodrigo.Siqueira@xxxxxxx>, "Christian König" <christian.koenig@xxxxxxx>, > "Alex Deucher" <alexander.deucher@xxxxxxx> > Cc: "Harry Wentland" <Harry.Wentland@xxxxxxx>, "Linux Doc Mailing List" <linux-doc@xxxxxxxxxxxxxxx>, "Mark Yacoub" > <markyacoub@xxxxxxxxxxxx>, "Michel Dänzer" <michel@xxxxxxxxxxx>, "Bas Nieuwenhuizen" <bas@xxxxxxxxxxxxxxxxxxx>, > "Roman Li" <roman.li@xxxxxxx>, "amd-gfx list" <amd-gfx@xxxxxxxxxxxxxxxxxxxxx>, "Roman Gilg" <subdiff@xxxxxxxxx>, > "Marek Olšák" <marek.olsak@xxxxxxx>, "Pekka Paalanen" <ppaalanen@xxxxxxxxx>, "Aurabindo Pillai" > <aurabindo.pillai@xxxxxxx>, "nicholas choi" <nicholas.choi@xxxxxxx>, "Maling list - DRI developers" > <dri-devel@xxxxxxxxxxxxxxxxxxxxx>, "Simon Ser" <contact@xxxxxxxxxxx>, "Alex Deucher" <alexdeucher@xxxxxxxxx>, "Sean > Paul" <seanpaul@xxxxxxxxxxxx>, "Qingqing Zhuo" <qingqing.zhuo@xxxxxxx>, "Bhawanpreet Lakha" > <bhawanpreet.lakha@xxxxxxx>, "Nicholas Kazlauskas" <nicholas.kazlauskas@xxxxxxx> > Envoyé: Mardi 30 Novembre 2021 16:53:55 > Objet: Re: [PATCH 6/6] Documentation/gpu: Add DC glossary > > > > On 2021-11-29 3:48 p.m., ydirson@xxxxxxx 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. Sure, especially as the Right Solution(tm) is not necessarily obvious :) One thing I thought about is that a context could be specified together with terms. Like "BPP (graphics)", "FEC (CS)", "DMCUB (amdgpu)". Well, "CS" may not be a good choice but you get the idea: that would keep all terms together and keep it easy for the reader. That way it could be easily be generalized at some point by just moving it to a generic kernel level - provided the solution suits the doc community at large. Best regards, -- Yann
