Re: [PATCH] list_lru: expand list_lru_add() docs with info about sublists

[Alice Ryhl]

On Fri, Nov 29, 2024 at 12:05 AM Matthew Wilcox <willy@xxxxxxxxxxxxx> wrote:
>
> On Thu, Nov 28, 2024 at 12:12:11PM +0000, Alice Ryhl wrote:
> > - * Return: true if the list was updated, false otherwise
> > + * Return value: true if the item was added, false otherwise
>
> This is an incorrect change.  The section is always called 'Return', not
> 'Return value'; see Documentation/doc-guide/kernel-doc.rst.  And I
> think it was fine to say "list was updated" rather than "item was
> added".  They're basically synonyms.
>
> > - * Return value: true if the list was updated, false otherwise
> > + * Return value: true if the item was added, false otherwise
>
> Ditto (and other similar changes)

Oh I had not noticed the "Return"/"Return value" change. It must be a
copy-paste artifact from list_lru_del_obj() which already uses "Return
value". Would you like me to change that one to 'Return'?

As for the other rewording, I thought it was slightly more
unambiguous, but don't feel strongly about it.

Alice