mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Shuah Khan <shuahkh@osg.samsung.com>
To: Jani Nikula <jani.nikula@linux.intel.com>,
	Jonathan Corbet <corbet@lwn.net>
Cc: richardcochran@gmail.com, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, netdev@vger.kernel.org,
	linux-kselftest@vger.kernel.org,
	Shuah Khan <shuahkh@osg.samsung.com>
Subject: Re: [PATCH 0/9] Move runnable code (tests) from Documentation to selftests
Date: Tue, 13 Sep 2016 07:25:50 -0600	[thread overview]
Message-ID: <235dbbac-4950-9631-908a-b2dfbbd06def@osg.samsung.com> (raw)
In-Reply-To: <87sht4tav2.fsf@intel.com>

On 09/13/2016 03:20 AM, Jani Nikula wrote:
> On Sat, 10 Sep 2016, Jonathan Corbet <corbet@lwn.net> wrote:
>> On Fri,  9 Sep 2016 16:22:41 -0600
>> Shuah Khan <shuahkh@osg.samsung.com> wrote:
>>
>>> 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

  reply	other threads:[~2016-09-13 13:25 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-09 22:22 Shuah Khan
2016-09-09 22:22 ` [PATCH 1/9] selftests: move dnotify_test from Documentation/filesystems Shuah Khan
2016-09-10  8:08   ` kbuild test robot
2016-09-09 22:22 ` [PATCH 2/9] selftests: update filesystems Makefile to work under selftests Shuah Khan
2016-09-13 11:56   ` Michael Ellerman
2016-09-13 13:20     ` Shuah Khan
2016-09-09 22:22 ` [PATCH 3/9] selftests: move .gitignore from Documentation/filesystems Shuah Khan
2016-09-09 22:22 ` [PATCH 4/9] selftests: move prctl tests from Documentation/prctl Shuah Khan
2016-09-09 23:58   ` kbuild test robot
2016-09-10  0:05   ` kbuild test robot
2016-09-09 22:22 ` [PATCH 5/9] selftests: Update prctl Makefile to work under selftests Shuah Khan
2016-09-09 22:22 ` [PATCH 6/9] selftests: move ptp tests from Documentation/ptp Shuah Khan
2016-09-10  0:07   ` kbuild test robot
2016-09-09 22:22 ` [PATCH 7/9] selftests: Update ptp Makefile to work under selftests Shuah Khan
2016-09-10 13:32   ` Sergei Shtylyov
2016-09-09 22:22 ` [PATCH 8/9] selftests: move vDSO tests from Documentation/vDSO Shuah Khan
2016-09-10  0:46   ` kbuild test robot
2016-09-09 22:22 ` [PATCH 9/9] selftests: Update vDSO Makefile to work under selftests Shuah Khan
2016-09-10 13:33   ` Sergei Shtylyov
2016-09-10  7:01 ` [PATCH 0/9] Move runnable code (tests) from Documentation to selftests Jonathan Corbet
2016-09-13  9:20   ` Jani Nikula
2016-09-13 13:25     ` Shuah Khan [this message]
2016-09-13 13:45       ` Jani Nikula

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=235dbbac-4950-9631-908a-b2dfbbd06def@osg.samsung.com \
    --to=shuahkh@osg.samsung.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=richardcochran@gmail.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

all inboxes | Powered by JetHome®