[PATCH] drm: Fix no_vblank field references in documentation
Randy Dunlap
rdunlap at infradead.org
Tue Apr 16 21:02:42 UTC 2024
On 4/16/24 2:00 PM, Marijn Suijten wrote:
> Hi Randy,
>
> [..]
>
>> Do you see differences in the generated html for these changes?
>
> I have not yet generated the HTML locally to test this patch, but will surely do
> if that's a requirement.
>
>> "&struct somestruct" and "&somestruct" should both be OK AFAIK, although
>> Documentation/doc-guide/kernel-doc.rst seems to say that using
>> "&struct somestruct" is preferred.
>
> Keep in mind that this patch is about field/member references. Quoting the
> relevant paragraph under "Highlights and cross-references":
>
> ``&struct_name->member`` or ``&struct_name.member``
> Structure or union member reference. The cross-reference will be to the struct
> or union definition, not the member directly.
>
> This lacks the struct tag entirely, and observation shows that links with them
> don't highlight correctly (hence this patch) while member links without struct
> tag are clickable and have an anchor link to their parent struct.
Alrigthy. Thank you.
--
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html
More information about the dri-devel
mailing list