From: Takashi Iwai <tiwai@suse.de> To: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>, "Jonathan Corbet" <corbet@lwn.net>, "Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>, 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 Date: Mon, 04 Jul 2022 14:54:19 +0200 [thread overview] Message-ID: <87y1x9xclg.wl-tiwai@suse.de> (raw) In-Reply-To: <3cd6b93b36b32ad6ae160931aaa00b20688e241a.1656759989.git.mchehab@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 <mchehab@kernel.org> 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 >
WARNING: multiple messages have this Message-ID (diff)
From: Takashi Iwai <tiwai@suse.de> To: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: alsa-devel@alsa-project.org, Jonathan Corbet <corbet@lwn.net>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, linux-kernel@vger.kernel.org, Linux Doc Mailing List <linux-doc@vger.kernel.org>, Takashi Iwai <tiwai@suse.com> Subject: Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file Date: Mon, 04 Jul 2022 14:54:19 +0200 [thread overview] Message-ID: <87y1x9xclg.wl-tiwai@suse.de> (raw) In-Reply-To: <3cd6b93b36b32ad6ae160931aaa00b20688e241a.1656759989.git.mchehab@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 <mchehab@kernel.org> 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 >
next prev parent reply other threads:[~2022-07-04 12:55 UTC|newest] Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-07-02 11:07 [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Mauro Carvalho Chehab 2022-07-02 11:07 ` [dm-devel] " Mauro Carvalho Chehab 2022-07-02 11:07 ` Mauro Carvalho Chehab 2022-07-02 11:07 ` [PATCH 01/12] docs: ext4: blockmap.rst: fix a broken table Mauro Carvalho Chehab 2022-07-02 11:07 ` [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice Mauro Carvalho Chehab 2022-07-06 20:48 ` Dipen Patel 2022-07-06 21:40 ` Thierry Reding 2022-07-07 18:54 ` Jonathan Corbet 2022-07-02 11:07 ` [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst Mauro Carvalho Chehab 2022-07-02 11:07 ` [dm-devel] " Mauro Carvalho Chehab 2022-07-02 11:07 ` [PATCH 04/12] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork Mauro Carvalho Chehab 2022-07-12 19:57 ` Bjorn Helgaas 2022-07-02 11:07 ` [PATCH 05/12] docs: PCI: pci-vntb-howto.rst: fix a title markup Mauro Carvalho Chehab 2022-07-12 19:58 ` Bjorn Helgaas 2022-07-02 11:07 ` [PATCH 06/12] docs: virt: kvm: fix a title markup at api.rst Mauro Carvalho Chehab 2022-07-02 11:07 ` [PATCH 07/12] docs: ABI: sysfs-bus-nvdimm Mauro Carvalho Chehab 2022-07-07 5:31 ` kajoljain 2022-07-02 11:07 ` [PATCH 08/12] kunit: test.h: fix a kernel-doc markup Mauro Carvalho Chehab 2022-07-02 13:18 ` David Gow 2022-07-08 17:30 ` Shuah Khan 2022-07-02 11:07 ` [PATCH 09/12] net: mac80211: " Mauro Carvalho Chehab 2022-07-02 11:07 ` [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file Mauro Carvalho Chehab 2022-07-02 11:07 ` Mauro Carvalho Chehab 2022-07-04 12:54 ` Takashi Iwai [this message] 2022-07-04 12:54 ` Takashi Iwai 2022-07-09 9:56 ` Mauro Carvalho Chehab 2022-07-09 9:56 ` Mauro Carvalho Chehab 2022-07-02 11:07 ` [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow Mauro Carvalho Chehab 2022-07-06 16:34 ` Doug Anderson 2022-07-06 22:29 ` Doug Anderson 2022-07-08 22:19 ` (subset) " Bjorn Andersson 2022-07-02 11:07 ` [PATCH 12/12] docs: leds: index.rst: add leds-qcom-lpg to it Mauro Carvalho Chehab 2022-07-03 3:26 ` [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Bagas Sanjaya 2022-07-03 3:26 ` [dm-devel] " Bagas Sanjaya 2022-07-03 3:26 ` Bagas Sanjaya
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=87y1x9xclg.wl-tiwai@suse.de \ --to=tiwai@suse.de \ --cc=alsa-devel@alsa-project.org \ --cc=corbet@lwn.net \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mchehab+huawei@kernel.org \ --cc=mchehab@kernel.org \ --cc=perex@perex.cz \ --cc=tiwai@suse.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.