From: Jonathan Corbet <corbet@lwn.net>
To: Federico Vaga <federico.vaga@gmail.com>
Cc: Hans Verkuil <hverkuil@xs4all.nl>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Pawel Osciak <pawel@osciak.com>,
Marek Szyprowski <m.szyprowski@samsung.com>,
Hans Verkuil <hans.verkuil@cisco.com>,
Giancarlo Asnaghi <giancarlo.asnaghi@st.com>,
linux-media@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 3/4] videobuf2-dma-streaming: new videobuf2 memory allocator
Date: Thu, 13 Sep 2012 11:54:38 -0600 [thread overview]
Message-ID: <20120913115438.0557462f@lwn.net> (raw)
In-Reply-To: <17733334.UmoCxqVfBu@harkonnen>
On Thu, 13 Sep 2012 17:42:33 +0200
Federico Vaga <federico.vaga@gmail.com> wrote:
> > The header and esp. the source could really do with more
> > documentation. It is not at all clear from the code what the
> > dma-streaming allocator does and how it differs from other
> > allocators.
>
> The other allocators are not documented and to understand them I read
> the code. All the memory allocators reflect a kind of DMA interface: SG
> for scatter/gather, contig for choerent and (now) streaming for
> streaming. So, I'm not sure to understand what do you think is the
> correct way to document a memory allocator; I can write one or two lines
> of comment to summarize each function. what do you think?
Well, there is some documentation here:
https://lwn.net/Articles/447435/
This reminds me that I've always meant to turn it into something to put
into Documentation/. I'll try to get to that soon.
In general, the fact that a subsystem is insufficiently documented is not
a good reason to add more poorly-documented code. We are, after all,
trying to make the kernel better over time...
Thanks,
jon
next prev parent reply other threads:[~2012-09-13 17:53 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-13 13:52 [PATCH 1/4] v4l: vb2: add prepare/finish callbacks to allocators Federico Vaga
2012-09-13 13:52 ` [PATCH 2/4] adv7180: remove {query/g_/s_}ctrl Federico Vaga
2012-09-13 13:52 ` [PATCH 3/4] videobuf2-dma-streaming: new videobuf2 memory allocator Federico Vaga
2012-09-13 14:07 ` Marek Szyprowski
2012-09-13 15:46 ` Federico Vaga
2012-09-13 17:45 ` Jonathan Corbet
2012-09-13 18:27 ` Federico Vaga
2012-09-13 14:08 ` Hans Verkuil
2012-09-13 15:42 ` Federico Vaga
2012-09-13 17:54 ` Jonathan Corbet [this message]
2012-09-13 18:14 ` Federico Vaga
2012-09-14 18:34 ` Ezequiel Garcia
2012-09-13 13:52 ` [PATCH 4/4] sta2x11_vip: convert to videobuf2 and control framework Federico Vaga
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=20120913115438.0557462f@lwn.net \
--to=corbet@lwn.net \
--cc=federico.vaga@gmail.com \
--cc=giancarlo.asnaghi@st.com \
--cc=hans.verkuil@cisco.com \
--cc=hverkuil@xs4all.nl \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=m.szyprowski@samsung.com \
--cc=mchehab@infradead.org \
--cc=pawel@osciak.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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox