Re: [PATCH v3 12/18] mm/huge_memory: add kerneldoc for the split helpers

[David Hildenbrand (Arm)]

On 8/20/26 20:55, Kairui Song via B4 Relay wrote:
> From: Kairui Song <kasong@xxxxxxxxxxx>
> 
> Document __folio_split_unmap_and_freeze() and
> __folio_split_unmap_and_freeze_file(), and rename the file split
> helper's definition to match its call site.

We don't really write kerneldoc for internal helpers.

If you need excessive documentation for internal helpers, it could be that the
function semantics are not clear enough to be expressed by a descriptive
function name + variable names.

Sometimes taking a step back and questioning how the code could be reworked to
be more self-documenting helps.

-- 
Cheers,

David