On Thu, 13 Sep 2012 17:42:33 +0200 Federico Vaga <federico.vaga@xxxxxxxxx> 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 -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
