linux-kernel - Re: Improving documentation for programming interfaces

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: <5185a8a7-1fdd-a9b9-eeef-f5952485e1c0@web.de>
Date:   Fri, 1 May 2020 09:20:23 +0200
From:   Markus Elfring <Markus.Elfring@....de>
To:     "Theodore Y. Ts'o" <tytso@....edu>, linux-doc@...r.kernel.org,
        kernel-janitors@...r.kernel.org
Cc:     LKML <linux-kernel@...r.kernel.org>
Subject: Re: Improving documentation for programming interfaces

>> I propose to encode helpful information into macro calls as needed
>> for the C programming language.
…
> On the "benefits" side of the equation, is there are ways in which it
> will directly benefit the kernel developers who will need to review
> the patches and review the annotations, that can be demonstrated
> immediately?  Not in some abstract way, or "when I my research work is
> completed", but a very concrete way that will be obvious to those of
> us who are still not completely convinced?

Would any contributors like to clarify further possibilities around
the application of source code annotation languages?

Regards,
Markus