From: "Enrico Weigelt, metux IT consult" <lkml@metux.net>
To: "Theodore Y. Ts'o" <tytso@mit.edu>,
Markus Elfring <Markus.Elfring@web.de>
Cc: linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
LKML <linux-kernel@vger.kernel.org>
Subject: Re: Improving documentation for programming interfaces
Date: Wed, 8 Jan 2020 13:04:31 +0100 [thread overview]
Message-ID: <17931ddd-76ec-d342-912c-faed6084e863@metux.net> (raw)
In-Reply-To: <20191220151945.GD59959@mit.edu>
On 20.12.19 16:19, Theodore Y. Ts'o wrote:
Hi folks,
> On Fri, Dec 20, 2019 at 02:30:10PM +0100, Markus Elfring wrote:
>> Linux supports some programming interfaces. Several functions are provided
>> as usual. Their application documentation is an ongoing development challenge.
>>
>> Now I would like to clarify possibilities for the specification of desired
>> information together with data types besides properties which are handled by
>> the programming language “C” so far.
@Markus:
hmm, maybe we could add some kinda-OOP-style metadata into the type
documentation ? Or maybe extend doxygen to crossref types vs functions
operating on them.
>> It seems that no customised attributes are supported at the moment.
>> Thus I imagine to specify helpful annotations as macros.
Do you mean _attribute__(...) or comments ?
<snip>
> It's unclear to me what you are requesting/proposing? Can you be a
> bit more concrete?
@Ted:
I guess he's thinking about some kind of meta-language for expressing
common things we know from oop-world, like ctors, dtors, getters, etc.
Maybe some doxygen experts here, who could tell what we already could
extract from existing sources ?
For start, I'd like to propose a few rules:
* consistent naming of 'release' functions (AFAIK, many of them are
already named <foo>_put()).
* for each non-trivial (non-private) object/struct, there should be
a corresponding release function (even if it's just an alias to
kfree()
* consistent nameing of list-type structs, so generic macros can
be used on the struct itself (instead just a container list header
struct)
--mtx
--
---
Hinweis: unverschlüsselte E-Mails können leicht abgehört und manipuliert
werden ! Für eine vertrauliche Kommunikation senden Sie bitte ihren
GPG/PGP-Schlüssel zu.
---
Enrico Weigelt, metux IT consult
Free software and Linux embedded engineering
info@metux.net -- +49-151-27565287
next prev parent reply other threads:[~2020-01-08 12:05 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-20 13:30 Improving documentation for programming interfaces Markus Elfring
2019-12-20 15:19 ` Theodore Y. Ts'o
2019-12-20 16:23 ` Markus Elfring
2019-12-20 17:17 ` Theodore Y. Ts'o
2019-12-20 18:00 ` Markus Elfring
2020-01-08 12:04 ` Enrico Weigelt, metux IT consult [this message]
2020-01-08 12:40 ` Markus Elfring
2020-01-08 16:14 ` Theodore Y. Ts'o
2020-01-08 16:55 ` Markus Elfring
2020-05-01 7:20 ` Markus Elfring
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=17931ddd-76ec-d342-912c-faed6084e863@metux.net \
--to=lkml@metux.net \
--cc=Markus.Elfring@web.de \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=tytso@mit.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).