From: Brendan Higgins <brendanhiggins@google.com>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Daniel Latypov <dlatypov@google.com>,
David Gow <davidgow@google.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
"open list:KERNEL SELFTEST FRAMEWORK"
<linux-kselftest@vger.kernel.org>,
Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH] lib: add basic KUnit test for lib/math
Date: Thu, 22 Oct 2020 14:21:40 -0700 [thread overview]
Message-ID: <CAFd5g46RBSgqujAbPSKasP5B6ufojHwTztvOWjSg3Lxk5QGHxw@mail.gmail.com> (raw)
In-Reply-To: <20201022190526.GN4077@smile.fi.intel.com>
On Thu, Oct 22, 2020 at 12:04 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> On Thu, Oct 22, 2020 at 11:53:50AM -0700, Brendan Higgins wrote:
> > On Thu, Oct 22, 2020 at 8:06 AM Andy Shevchenko
> > <andriy.shevchenko@linux.intel.com> wrote:
> > > On Wed, Oct 21, 2020 at 10:47:50AM -0700, Daniel Latypov wrote:
>
> ...
>
> > > You need to put detailed comments in the code to have it as real example how to
> > > create the KUnit test. But hey, it will mean that documentation sucks. So,
> > > please update documentation to cover issues that you found and which motivated
> > > you to create these test cases.
> >
> > I don't entirely disagree; leaning too heavily on code examples can be
> > detrimental to docs. That being said, when I use other people's code,
> > I often don't even look at the docs. So, I think the ideal is to have
> > both.
>
> Why do we have docs in the first place?
> For test cases I think it's a crucial part, because tests many time are written
> by newbies, who would like to understand all under-the-hood stuff. You imply
Good point. Yeah, we don't really have any documentation that explains
the internals at all. I agree: we need to fix that.
> that they need to drop themselves into the code directly. It's very harsh to
> begin with Linux kernel development, really.
No, I was not trying to imply that everyone should just jump in the
code and ignore the docs. I was just trying to point out that some
people - myself included - rather see code than docs. Clearly some
people prefer docs over code as well. Thus, I was trying to argue that
both are appropriate.
Nevertheless, based on the other comments you sent, I don't think
that's what we are talking about: sounds like you just want us to
improve the docs first to make sure we do it. That's fine with me.
> > > Summarize this, please create usable documentation first.
>
> So, no go for this w/o documentation being up-to-date. Or be honest to
> everybody, it's sucks it needs to be removed. Then I will get your point.
>
> --
> With Best Regards,
> Andy Shevchenko
>
>
next prev parent reply other threads:[~2020-10-22 21:21 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-19 22:45 [PATCH] lib: add basic KUnit test for lib/math Daniel Latypov
2020-10-20 0:45 ` kernel test robot
2020-10-20 8:09 ` Andy Shevchenko
2020-10-20 16:13 ` Daniel Latypov
2020-10-21 3:40 ` David Gow
2020-10-21 17:47 ` Daniel Latypov
2020-10-22 15:06 ` Andy Shevchenko
2020-10-22 16:26 ` Daniel Latypov
2020-10-22 18:51 ` Brendan Higgins
2020-10-22 19:10 ` Andy Shevchenko
2020-10-22 19:12 ` Andy Shevchenko
2020-10-22 18:53 ` Brendan Higgins
2020-10-22 19:05 ` Andy Shevchenko
2020-10-22 21:21 ` Brendan Higgins [this message]
2020-10-23 9:02 ` Andy Shevchenko
2020-11-02 14:51 ` kernel test robot
2020-11-03 1:32 ` kernel test robot
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=CAFd5g46RBSgqujAbPSKasP5B6ufojHwTztvOWjSg3Lxk5QGHxw@mail.gmail.com \
--to=brendanhiggins@google.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=davidgow@google.com \
--cc=dlatypov@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
/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;
as well as URLs for NNTP newsgroup(s).