From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A8B29CA9EC0 for ; Mon, 28 Oct 2019 14:44:22 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 817C921744 for ; Mon, 28 Oct 2019 14:44:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2390286AbfJ1OoV (ORCPT ); Mon, 28 Oct 2019 10:44:21 -0400 Received: from mx2.suse.de ([195.135.220.15]:59076 "EHLO mx1.suse.de" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1727982AbfJ1OoV (ORCPT ); Mon, 28 Oct 2019 10:44:21 -0400 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.220.254]) by mx1.suse.de (Postfix) with ESMTP id 3C01CAC2D; Mon, 28 Oct 2019 14:44:19 +0000 (UTC) Date: Mon, 28 Oct 2019 15:44:19 +0100 Message-ID: From: Takashi Iwai To: Markus Elfring Cc: Navid Emamdoost , alsa-devel@alsa-project.org, linux-doc@vger.kernel.org, Navid Emamdoost , Kangjie Lu , Stephen McCamant , Greg Kroah-Hartman , Richard Fontana , Thomas Gleixner , kernel-janitors@vger.kernel.org, LKML Subject: Re: [alsa-devel] ALSA: korg1212: Checking exception handling in snd_korg1212_create() In-Reply-To: <0daa3e27-3d1f-3040-f8e7-92ce91a97687@web.de> References: <0daa3e27-3d1f-3040-f8e7-92ce91a97687@web.de> User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI/1.14.6 (Maruoka) FLIM/1.14.9 (=?UTF-8?B?R29qxY0=?=) APEL/10.8 Emacs/25.3 (x86_64-suse-linux-gnu) MULE/6.0 (HANACHIRUSATO) MIME-Version: 1.0 (generated by SEMI 1.14.6 - "Maruoka") Content-Type: text/plain; charset=US-ASCII Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, 28 Oct 2019 15:40:09 +0100, Markus Elfring wrote: > > >> Can the properties of this programming interface be documented also together > >> with the function declaration for the safer handling of ALSA components? > >> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/sound/kernel-api/writing-an-alsa-driver.rst?id=d6d5df1db6e9d7f8f76d2911707f7d5877251b02#n567 > > > > I can think of only adding some comment at each point mentioning that > > the resource will be managed by the device destructor. > > * Which places will be corresponding update candidates? At each place where this kind of code is seen. > * Would you like to choose the wording? I myself don't mind as long as it's clearly understandable for human being. > >> Can any more API information help to improve automatic source code analysis > >> around similar functions? > > > > If anything we can add, let me know. > > Will any tags become more helpful also for the software documentation? It's my question. thanks, Takashi