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=-0.7 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no 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 7B38BC433DF for ; Thu, 14 May 2020 09:21:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 609F220671 for ; Thu, 14 May 2020 09:21:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726165AbgENJVB (ORCPT ); Thu, 14 May 2020 05:21:01 -0400 Received: from mx2.suse.de ([195.135.220.15]:54610 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725878AbgENJVB (ORCPT ); Thu, 14 May 2020 05:21:01 -0400 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.220.254]) by mx2.suse.de (Postfix) with ESMTP id BE94AAF68; Thu, 14 May 2020 09:21:02 +0000 (UTC) Date: Thu, 14 May 2020 11:20:59 +0200 Message-ID: From: Takashi Iwai To: changjoon.lee@lge.com Cc: alsa-devel@alsa-project.org, linux@endlessm.com, linux-kernel@vger.kernel.org Subject: Re: [PATCH 0/1] Documentation update In-Reply-To: <20200514090716.39413-1-changjoon.lee@lge.com> References: <20200514090716.39413-1-changjoon.lee@lge.com> 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 Thu, 14 May 2020 11:07:15 +0200, changjoon.lee@lge.com wrote: > > From: ChangJoon Lee > > Hi, ALSA Teams, > > This is documentation update purpose patch. > This patch does NOT alter any of operations. > > This patch allows an application engineer to understand why they received negative return > such as -EIO, -EBADFD, -ENOSYS, -ESTRPIPE and etc which are not fully documented on documentation site. > > This patch also exposes Expected Status of PCM based on bad_pcm_state() with P_STATE to help engineer to understand API behavior to the documentation site. > > TODO : > We may need improve consistency of return value especially for snd_pcm_hw_params_current(). > It returns -EBADFD when PCM is not setup while other API returns -EIO in this case. Could you put those explanations rather into the patch description, not (only) in the cover letter? thanks, Takashi