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 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A5AA6C32792 for ; Mon, 22 Aug 2022 06:24:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232964AbiHVGYE (ORCPT ); Mon, 22 Aug 2022 02:24:04 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42098 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232968AbiHVGX7 (ORCPT ); Mon, 22 Aug 2022 02:23:59 -0400 Received: from mail-lf1-x133.google.com (mail-lf1-x133.google.com [IPv6:2a00:1450:4864:20::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9BD90BF73 for ; Sun, 21 Aug 2022 23:23:57 -0700 (PDT) Received: by mail-lf1-x133.google.com with SMTP id l1so13332302lfk.8 for ; Sun, 21 Aug 2022 23:23:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc; bh=lXv6C4ziikq0Sk1u9o+9E/ygkgO4M7OfefUbcJQuZS0=; b=mf/WJjn1MszBhA+W+uGZlPsR1F6DgH4zptkQ7VA5aENzvFUL9qdXSufI2YS7yugp47 9sc24THU+WfUoj65q8Kfg0xDch8BkradgaqC8cx+V+YEO8poJNiayd0RZkWV9m+aYh/T 8YmC6GXvva88i2PjJnsKOhLXEwvLjPrNABuxOo1ROd6INbDejWYZxGm5mvj0J1DVKh5M mYsiOb+V1ouTuqnKEH6ZqKAtl2Z7oUizTRvCEaP8kVOI4rkqxPwO8wbRO2byBxYOJXz7 2Z/AC9bxt2anlNuIcDaw2riRoBU0AKy1DcaHBuD4TMkwFicxRiywySdd+xlrJSe8BH9u 83GA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc; bh=lXv6C4ziikq0Sk1u9o+9E/ygkgO4M7OfefUbcJQuZS0=; b=bMZBog+LNOP+hEv6536REzZNbvAsRYuq8kElTmO+yv6GnwIMJ4iPW9ADvo+CqchBuC mHrb2sdHcr5y2/Ez5akkDd7KNT8F8dpBad7/srWwr2Lk30AnnPSMAn7hgGt6FslMOqwb yO3ERzQDF10rv0EqpOVaYW4vtWLKY9ucFzYxj5Pm/oxrlu4wgt/HtHROm7MBrXIjjKQ8 Ai6K+kjtYwpKzq6oZsxVVAQ9JEe53ybZPuLizFu0tqkM9ubjLZV4QesO7pePlZmN8s5K B9qx8TOkutJgBhBWS5CHENT35cPWX2ewsevpffzhp1ZHxctBfyNyBtrMLUVhOYxF7Uhp XU4A== X-Gm-Message-State: ACgBeo2E+gnEKhtu7df2nVNIxlUkzwkgY0UFVBzB34Q2zdCdGkX/7X+r zBeq5Vkrz5M6pNBvxBYRYbT19o6XGYjXcs84Rd2lmw== X-Google-Smtp-Source: AA6agR4BC0onHpDvAguYukadM/PXtogJuZSt8ELq9PbS1pk+o0G89dG6L7g69m9hnPyfZN6DRJbsjiuQxrL0v32q9Xg= X-Received: by 2002:ac2:549c:0:b0:492:bdc8:760b with SMTP id t28-20020ac2549c000000b00492bdc8760bmr5783930lfk.188.1661149435591; Sun, 21 Aug 2022 23:23:55 -0700 (PDT) MIME-Version: 1.0 References: <20220822022646.98581-1-tales.aparecida@gmail.com> <20220822022646.98581-6-tales.aparecida@gmail.com> In-Reply-To: <20220822022646.98581-6-tales.aparecida@gmail.com> From: Sadiya Kazi Date: Mon, 22 Aug 2022 11:53:44 +0530 Message-ID: Subject: Re: [PATCH v2 5/8] Documentation: KUnit: add intro to the getting-started page To: Tales Aparecida Cc: Tim.Bird@sony.com, linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org, David Gow , corbet@lwn.net, brendan.higgins@linux.dev, Trevor Woerner , siqueirajordao@riseup.net, mwen@igalia.com, andrealmeid@riseup.net, mairacanal@riseup.net, Isabella Basso , magalilemes00@gmail.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, Aug 22, 2022 at 8:00 AM Tales Aparecida wrote: > > Describe the objective of the Getting Started page, which should be a > brief and beginner-friendly walkthrough for running and writing tests, > showing the reader where to find detailed instructions in other pages. > > Signed-off-by: Tales Aparecida > Reviewed-by: Ma=C3=ADra Canal > > --- > Notes: > Remove recommendation about having compiled the kernel before using > kunit_tool. I changed my mind about it after Tim Bird's highlight. > --- Hi Tales, Thank you for helping with this documentation. You can provide the below content as an intro to this page: This page covers information you'll need to know when you're new to working with KUnit. It includes topics like running tests, writing a simple test case, and covers common problems users face when using KUnit for the first time. Reviewed-by:Sadiya Kazi Regards, Sadiya > Documentation/dev-tools/kunit/start.rst | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-= tools/kunit/start.rst > index adf782507999..75fd05286396 100644 > --- a/Documentation/dev-tools/kunit/start.rst > +++ b/Documentation/dev-tools/kunit/start.rst > @@ -4,6 +4,10 @@ > Getting Started > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > > +This page contains an overview of the kunit_tool and KUnit framework, > +teaching how to run existing tests and then how to write a simple test c= ase, > +and covers common problems users face when using KUnit for the first tim= e. > + > Installing Dependencies > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > KUnit has the same dependencies as the Linux kernel. As long as you can > -- > 2.37.2 >