From: "Theodore Y. Ts'o" <tytso@mit.edu>
To: 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: Fri, 20 Dec 2019 15:19:45 +0000 [thread overview]
Message-ID: <20191220151945.GD59959@mit.edu> (raw)
In-Reply-To: <350cd156-9080-24fe-c49e-96e758d3ca45@web.de>
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.
> It seems that no customised attributes are supported at the moment.
> Thus I imagine to specify helpful annotations as macros.
>
> Example:
> Some functions allocate resources to which a pointer (or handle) is returned.
> I would find it nice then if such a pointer would contain also the background
> information by which functions the resource should usually be released.
>
> Can it become easier to determine such data?
Markus,
It's unclear to me what you are requesting/proposing? Can you be a
bit more concrete?
- Ted
WARNING: multiple messages have this Message-ID (diff)
From: "Theodore Y. Ts'o" <tytso@mit.edu>
To: 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: Fri, 20 Dec 2019 10:19:45 -0500 [thread overview]
Message-ID: <20191220151945.GD59959@mit.edu> (raw)
In-Reply-To: <350cd156-9080-24fe-c49e-96e758d3ca45@web.de>
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.
> It seems that no customised attributes are supported at the moment.
> Thus I imagine to specify helpful annotations as macros.
>
> Example:
> Some functions allocate resources to which a pointer (or handle) is returned.
> I would find it nice then if such a pointer would contain also the background
> information by which functions the resource should usually be released.
>
> Can it become easier to determine such data?
Markus,
It's unclear to me what you are requesting/proposing? Can you be a
bit more concrete?
- Ted
next prev parent reply other threads:[~2019-12-20 15:19 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-20 13:30 Improving documentation for programming interfaces Markus Elfring
2019-12-20 13:30 ` Markus Elfring
2019-12-20 15:19 ` Theodore Y. Ts'o [this message]
2019-12-20 15:19 ` Theodore Y. Ts'o
2019-12-20 16:23 ` Markus Elfring
2019-12-20 16:23 ` Markus Elfring
2019-12-20 17:17 ` Theodore Y. Ts'o
2019-12-20 17:17 ` Theodore Y. Ts'o
2019-12-20 18:00 ` Markus Elfring
2019-12-20 18:00 ` Markus Elfring
2020-01-08 12:04 ` Enrico Weigelt, metux IT consult
2020-01-08 12:04 ` Enrico Weigelt, metux IT consult
2020-01-08 12:40 ` Markus Elfring
2020-01-08 12:40 ` Markus Elfring
2020-01-08 16:14 ` Theodore Y. Ts'o
2020-01-08 16:14 ` Theodore Y. Ts'o
2020-01-08 16:55 ` Markus Elfring
2020-01-08 16:55 ` Markus Elfring
2020-05-01 7:20 ` 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=20191220151945.GD59959@mit.edu \
--to=tytso@mit.edu \
--cc=Markus.Elfring@web.de \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.