Re: [PATCH 0/9] Move runnable code (tests) from Documentation to selftests
From: Shuah Khan <hidden>
Date: 2016-09-13 13:25:58
Also in:
lkml
On 09/13/2016 03:20 AM, Jani Nikula wrote:
On Sat, 10 Sep 2016, Jonathan Corbet [off-list ref] wrote:quoted
On Fri, 9 Sep 2016 16:22:41 -0600 Shuah Khan [off-list ref] wrote:quoted
Move runnable code (tests) from Documentation to selftests and update Makefiles to work under selftests. Jon Corbet and I discussed this in an email thread and as per that discussion, this patch series moves all the tests that are under the Documentation directory to selftests. There is more runnable code in the form of examples and utils and that is going to be another patch series. I moved just the tests and left the documentation files as is.I'm fine with the idea, but it looks like a couple of tweaks are needed, in particular to avoid leaving behind dangling references in Documentation/Makefile that cause build errors. I think the individual patches probably need a wider CC list as well. I'd use the get_maintainer script (or git) to see who has taken an interest in the individual tests and make sure they are aware of the move.FWIW, I'm in favor of moving *all* the code away from Documentation, not just tests. Essentially removing the CONFIG_BUILD_DOCSRC config option, and reserving Documentation/Makefile for documentation build. After this series, some of the remaining code belongs under samples, some under tools.
I am planning another patch series to move all the examples and samples and tools to their right location.
We could make it possible to include the code samples from samples into the Sphinx built documentation. BR, Jani.
I can't say I understand Sphinx, however, it might make sense to include samples into Sphinx build. Is this approach different from the way they are built under Documentation via Doc Makfiles now? thanks, -- Shuah