Re: Improving documentation for programming interfaces

From: Theodore Y. Ts'o
Date: Fri Dec 20 2019 - 10:19:55 EST


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