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 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A3988C43334 for ; Mon, 4 Jul 2022 12:55:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232934AbiGDMz0 (ORCPT ); Mon, 4 Jul 2022 08:55:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34380 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233051AbiGDMzI (ORCPT ); Mon, 4 Jul 2022 08:55:08 -0400 Received: from smtp-out2.suse.de (smtp-out2.suse.de [195.135.220.29]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8ECDF12A99; Mon, 4 Jul 2022 05:54:23 -0700 (PDT) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 9D6CF1F9A7; Mon, 4 Jul 2022 12:54:20 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1656939260; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=4XGtWrKEsDeW+JGhKxyDrIugLqfJ8GgE7jN3CghaDj8=; b=NxLozBgzOs34VQ54vidimIOWDGNz+4X1kK9nsKHdsaUEYUmvKVAKtdTk2DC6cl6Qt8GZO3 fx7Uc4OD34OseTj1NILhvPXSlQdAuwLbcoHmw8r1IkZ6gcua43Cr3/P3HCNQYw+yxC0XWf i+zSurufkRSTxw7DI6RZESD04r0qUhc= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1656939260; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=4XGtWrKEsDeW+JGhKxyDrIugLqfJ8GgE7jN3CghaDj8=; b=yjwDXoX0B4ZmCPpPrg3JA3/gkzpqLAb06nFZxKousaUjn2mVySHWbgzWzJPX9Dh+6oQKEw E+7SSMu4RWUC+EBg== Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 6DE941342C; Mon, 4 Jul 2022 12:54:20 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id CcgXGvziwmLuNgAAMHmgww (envelope-from ); Mon, 04 Jul 2022 12:54:20 +0000 Date: Mon, 04 Jul 2022 14:54:19 +0200 Message-ID: <87y1x9xclg.wl-tiwai@suse.de> From: Takashi Iwai To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , "Jonathan Corbet" , "Mauro Carvalho Chehab" , Jaroslav Kysela , Takashi Iwai , alsa-devel@alsa-project.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file In-Reply-To: <3cd6b93b36b32ad6ae160931aaa00b20688e241a.1656759989.git.mchehab@kernel.org> References: <3cd6b93b36b32ad6ae160931aaa00b20688e241a.1656759989.git.mchehab@kernel.org> User-Agent: Wanderlust/2.15.9 (Almost Unreal) Emacs/27.2 Mule/6.0 MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue") Content-Type: text/plain; charset=US-ASCII Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Sat, 02 Jul 2022 13:07:42 +0200, Mauro Carvalho Chehab wrote: > > This file: > sound/core/compress_offload.c > > Doesn't define any docs, as everything is inside the header > file. So, drop it, in order to remove a Sphinx warning. > > Signed-off-by: Mauro Carvalho Chehab Hmm, it looks rather like that some comments (at least for exported functions) should be marked with kerneldoc markers instead. I'm going to fix those comments. thanks, Takashi > --- > > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. > See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/ > > Documentation/sound/kernel-api/alsa-driver-api.rst | 1 - > 1 file changed, 1 deletion(-) > > diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst > index d24c64df7069..3cf8eb4ecaf4 100644 > --- a/Documentation/sound/kernel-api/alsa-driver-api.rst > +++ b/Documentation/sound/kernel-api/alsa-driver-api.rst > @@ -86,7 +86,6 @@ Compress Offload > > Compress Offload API > -------------------- > -.. kernel-doc:: sound/core/compress_offload.c > .. kernel-doc:: include/uapi/sound/compress_offload.h > .. kernel-doc:: include/uapi/sound/compress_params.h > .. kernel-doc:: include/sound/compress_driver.h > -- > 2.36.1 >