From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.7 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 08A60C388F9 for ; Thu, 22 Oct 2020 19:04:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id AFA0224658 for ; Thu, 22 Oct 2020 19:04:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S369843AbgJVTE1 (ORCPT ); Thu, 22 Oct 2020 15:04:27 -0400 Received: from mga12.intel.com ([192.55.52.136]:29681 "EHLO mga12.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S369842AbgJVTE0 (ORCPT ); Thu, 22 Oct 2020 15:04:26 -0400 IronPort-SDR: 1ZPztXO1pg7WeFbQWvdnR19QN/3scV/MyT3n823RD+ZwjE1U7JI8+2RJ/RVZrmdv25ZNcSSp3x C1rlyn2cAdTQ== X-IronPort-AV: E=McAfee;i="6000,8403,9782"; a="146872723" X-IronPort-AV: E=Sophos;i="5.77,404,1596524400"; d="scan'208";a="146872723" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Oct 2020 12:04:26 -0700 IronPort-SDR: W9JF7A0t9YQMmFylVi0vver7sM5vwAcgBCSLRzHzTL7+3/fTF4zJZfcMvgmajOvTrzElQc4bBx rWzsHkck5mng== X-IronPort-AV: E=Sophos;i="5.77,404,1596524400"; d="scan'208";a="534085151" Received: from smile.fi.intel.com (HELO smile) ([10.237.68.40]) by orsmga005-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Oct 2020 12:04:24 -0700 Received: from andy by smile with local (Exim 4.94) (envelope-from ) id 1kVftu-00DVSp-Lj; Thu, 22 Oct 2020 22:05:26 +0300 Date: Thu, 22 Oct 2020 22:05:26 +0300 From: Andy Shevchenko To: Brendan Higgins Cc: Daniel Latypov , David Gow , Linux Kernel Mailing List , "open list:KERNEL SELFTEST FRAMEWORK" , Shuah Khan Subject: Re: [PATCH] lib: add basic KUnit test for lib/math Message-ID: <20201022190526.GN4077@smile.fi.intel.com> References: <20201019224556.3536790-1-dlatypov@google.com> <20201022150648.GH4077@smile.fi.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org On Thu, Oct 22, 2020 at 11:53:50AM -0700, Brendan Higgins wrote: > On Thu, Oct 22, 2020 at 8:06 AM Andy Shevchenko > 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 that they need to drop themselves into the code directly. It's very harsh to begin with Linux kernel development, really. > > 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