On 01/02/2017 08:28 PM, Jonathan Cameron wrote: > This series came out of the mess that became apparant when looking at the > autogenerated docs. As we pull the kernel-doc from buffer.h in when > describing the API the drivers use to access it we were pulling in a lot > of documentation that was irrelevant to that use case. > > Hence, this series does two things: > 1) Splits the buffer.h header into two parts: > * buffer.h which just contains the stuff that drivers using buffers need. > * buffer_impl.h which just contains the stuff related to the implementation > of buffers > This makes struct iio_buffer opaque to the drivers (with a few extra > access functions and a bit of code reorganization) > 2) Takes the documentation of struct iio_buffer inline, allowing fairly > sensible use of the private: label within docs rather than our local > iio specific tagging of documentation. There is an oddity here in that > I have deliberately 'broken' the kernel-doc for elements that are private > in order to avoid lots of warnings about excess documentation. > > Along the way various drivers gained additional includes that should probably > have been there in the first place. This was needed to cleanup the includes > within the includes. Most drivers did it 'right' anyway so this wasn't too > bad. > > I'll probably follow this up with similar cleanups elsewhere at some point. > > This was against 4.10-rc1 as that's where I'm working on docs, but should > go in reasonably cleanly on iio/togreg or iio/testing. Looks good. I'm not convinced the split is necessary, but it doesn't hurt either. Full series: Reviewed-by: Lars-Peter Clausen <lars@xxxxxxxxxx> -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
