Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp3317129ybl; Fri, 20 Dec 2019 07:22:14 -0800 (PST) X-Google-Smtp-Source: APXvYqycXgpxxMVwFu+AjvGZssBifbqXu2QYdn4bARjqUhL+CjbMT9tnlAePsHi30HZQTA4n21uO X-Received: by 2002:a05:6830:4a7:: with SMTP id l7mr13022552otd.372.1576855334390; Fri, 20 Dec 2019 07:22:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1576855334; cv=none; d=google.com; s=arc-20160816; b=U0tUADwI/uxNS6wAId9X6fSVG7eZezCB84dcrcvyCrCUttSxGL0AHbZnKsfyLKWjI/ aWuAxmF7V/ru2CIco59e5zasArypZd3OccvCm6m/F62lMKjn2TBMbUjB3r6J1QY4CX10 XJInBb2Xg8dQqCYlJzJ6hNAjmYpPmTkj3P9RJUKMMV2XQoFCjXiwTvg0iUKAlXAP0t4e YNg8O6/1P4ASTdznCs7AXxGjgPnaOB1zCwPYZmGFq2fYtFvkQ4Cqwcxx6YW7XUnt0VnB hdQXoqzGqTY7gn2Dxaivuwjacem5rA8nNIi9IKj6A0FtohsrodoY+LcnG2zSgO1Cp+33 +taA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:user-agent:in-reply-to :content-transfer-encoding:content-disposition:mime-version :references:message-id:subject:cc:to:from:date; bh=diwV8DU1baxF60k8Wcz+pwNZJgY1Ksb6ua5Se6ZSrh8=; b=Ej6zsRopD98SnAD6h12xKQKaVoKnDVVA4QUJBqkS6WPgeIUg6AJloIPvRzNRKb1BG9 g1tBnMn5BrnpYauNPcVWC+7r3Q/6+Uxq77qkXHrDVhJchAycPW0sdOmH/14LEsDZgZcn OOrWNmybyPXoUvrv9tOCnEi0+x3VfQCeEEwF7resJepPs81mYmhluO+0cUvromesLH7P +aHh2XGqpEFwl4S98lvUn9CQNG6eBPm1Ppp0CW3P53X3XMRGk7kySiWjKIFyn+Ejm2+M 31xQRTYlkKlC/rX8qw/v/GkTwBHzTK46MACnP6Jps+Emovn0tb5fjOvacRwXFwXmG5DN pkuw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id q7si2133901otn.108.2019.12.20.07.22.01; Fri, 20 Dec 2019 07:22:14 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727505AbfLTPTy (ORCPT + 99 others); Fri, 20 Dec 2019 10:19:54 -0500 Received: from outgoing-auth-1.mit.edu ([18.9.28.11]:60324 "EHLO outgoing.mit.edu" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1727233AbfLTPTy (ORCPT ); Fri, 20 Dec 2019 10:19:54 -0500 Received: from callcc.thunk.org (guestnat-104-133-0-111.corp.google.com [104.133.0.111] (may be forged)) (authenticated bits=0) (User authenticated as tytso@ATHENA.MIT.EDU) by outgoing.mit.edu (8.14.7/8.12.4) with ESMTP id xBKFJkke015295 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 20 Dec 2019 10:19:49 -0500 Received: by callcc.thunk.org (Postfix, from userid 15806) id 8749A420822; Fri, 20 Dec 2019 10:19:45 -0500 (EST) Date: Fri, 20 Dec 2019 10:19:45 -0500 From: "Theodore Y. Ts'o" To: Markus Elfring Cc: linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org, LKML Subject: Re: Improving documentation for programming interfaces Message-ID: <20191220151945.GD59959@mit.edu> References: <350cd156-9080-24fe-c49e-96e758d3ca45@web.de> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <350cd156-9080-24fe-c49e-96e758d3ca45@web.de> User-Agent: Mutt/1.12.2 (2019-09-21) Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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