linux-kernel - Re: [PATCH v2] docs: scheduler: completion: Document complete_on_current

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-Id: <DCGJ0S0C9ZZH.1IFDOEWH6YF2K@gmail.com>
Date: Sun, 31 Aug 2025 18:04:32 +0800
From: "Javier Carrasco" <javier.carrasco.cruz@...il.com>
To: "Peter Zijlstra" <peterz@...radead.org>, "Jonathan Corbet"
 <corbet@....net>
Cc: <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>, "Andrei
 Vagin" <avagin@...gle.com>
Subject: Re: [PATCH v2] docs: scheduler: completion: Document
 complete_on_current_cpu()

On Sun Aug 31, 2025 at 3:07 AM CST, Peter Zijlstra wrote:
> On Fri, Aug 29, 2025 at 04:44:28PM -0600, Jonathan Corbet wrote:
>> Javier Carrasco <javier.carrasco.cruz@...il.com> writes:
>> 
>> > Commit 6f63904c8f3e ("sched: add a few helpers to wake up tasks on the
>> > current cpu") introduced this new function to the completion API that
>> > has not been documented yet.
>> 
>> For a change like this, it is a really good idea to copy the author of
>> the original patch and others who were involved in it; I have added them
>> now.
>
> This really is a rather specialized thing -- not sure it makes sense to
> have in the document.
>

Hello Peter, thank you for your reply.

I agree that it is a rather specialized function, but in my opinion that
should not be a reason to exclude it from the documentation. Where do
you draw the line then? It is an exposed function from the API that can
be called like any other function from the API if the user requires that.


This one is by the way the only undocumented function from the completion
API.

Best regards,
Javier Carrasco