Received: by 2002:a05:6358:4e97:b0:b3:742d:4702 with SMTP id ce23csp1232498rwb; Thu, 18 Aug 2022 23:02:28 -0700 (PDT) X-Google-Smtp-Source: AA6agR5+H0G5GZuEerdDGsaCasJS4bXLnSsrPOlslFm83IIpvr6QPkGE/1Kflur0svj/X2RbBLUT X-Received: by 2002:a17:907:94d2:b0:73b:f1b0:3b74 with SMTP id dn18-20020a17090794d200b0073bf1b03b74mr3145762ejc.158.1660888947805; Thu, 18 Aug 2022 23:02:27 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1660888947; cv=none; d=google.com; s=arc-20160816; b=RSu1YrPiDECZmX0H0kKoHnA58WfdCugOp54wiP/lYe5ai/YSFyqlnuzRux0R+YjxKl 0Cbba/9rY4IkXcYPSBGXxvU4PPUY3qbQFnJgAb4cbuL+49PdAycWFPcgrlThsm+Vt/+t ezisyuTcyOsUsZqDyS9+O0CKVBV5GS4K1vQmcuhCNXmAz7Eb0f57LPUyTU+D6p5wv0Cb WxSRBvPyxjWnQutEcC/f+yW6iOhzkEm8eKM0EzUoN+6W1eC3eXIGo0uPHi6+i51c1i4O CWT1t1pps6rYTBWhereVHmORyekcBc8y9KajmnLv+xsNGDpo+8DBiXQVAABbuft5Oxzm jUgg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=c+0oqG7L/KIFE0prA1/0TP0LiidqFUxPZvUVbudAB6o=; b=Ee4evtIzk49crck4f7p0PXMKo+rqLDLXpytHuBeWRvaLDshSLLWGmEG0NaT6YkqrXV Xhk3FjoRq8C9OS0t4TPSuA1MGDVtnde3UBxgH1zfzdUoKZsVluFEpbtW15gTnxEeFaZ7 0edUDsO8LAwLJIzZayt+RY00ay7aiZZI8I4pvTXoh9qiqn259oJBOxbKiEfRuYYUckQd GHBRMhVK4ErOQHYADlRQ/kxbq57wYjb6Q8gl1kdImcRSSfizRWX0Sd6N0AUWVllLAmkZ 95e1ZP+xh/rudQQ11biHms2WD5xBr3Gtdf+5M02T7k8WfBnwxQejz97J/VwXhwrB/8+g Rt5Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=KyiJHGoF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id d8-20020a1709061f4800b00730a3b5af1fsi2424120ejk.338.2022.08.18.23.02.01; Thu, 18 Aug 2022 23:02:27 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=KyiJHGoF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1346394AbiHSFdM (ORCPT + 99 others); Fri, 19 Aug 2022 01:33:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51132 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1345813AbiHSFdG (ORCPT ); Fri, 19 Aug 2022 01:33:06 -0400 Received: from mail-ua1-x931.google.com (mail-ua1-x931.google.com [IPv6:2607:f8b0:4864:20::931]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7A8E5E0FD5; Thu, 18 Aug 2022 22:33:05 -0700 (PDT) Received: by mail-ua1-x931.google.com with SMTP id h19so1425017uan.9; Thu, 18 Aug 2022 22:33:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=c+0oqG7L/KIFE0prA1/0TP0LiidqFUxPZvUVbudAB6o=; b=KyiJHGoFLDiCyge0d+nP+PeH20Y+YBaro67sEpRGS1ubF2TUGhjVGteLDsPmlu27tp vgyBQvlW4hSiasIFZvJtALwzQm/e7cvGdBHJ/mMuohOZ+KkgTAgKMDy46PVndGPSuVow sFsoAlKefDdfdQFaYrdoUYshb/ntZB2HKpbILP+Ohv1GX7Ydgep6lI8go+KzQZy5u8DK hXlvNAJvBQnQJbemsAiaQzhOSPc1bkfAr1CaHJ1LSWEvIsHfQw19zTG0xk6A3kJbf8cU kkVQdhZDGXFHnNeziLzlIKf/xwfzOzLbpLMzNd30Rld/6cR4/JEk2gP1lbwb8y+SN50L jI5A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=c+0oqG7L/KIFE0prA1/0TP0LiidqFUxPZvUVbudAB6o=; b=viK6rbBsmK1dQPH56IuIDlODVw6uD+aE+2fpY4o7DEE83q4t4f019RotOgGtcQkYQ2 9oML8q+0lmvRVUHFSyJQ51k7Z6BE49mlQStuuQYW4h2xFoo3ZxxexgY4IJfZ5HsYwjl8 pbxndOJtfJAvQlFtlc5p9lZcuxNxhzV7FDm0j0nTfqS5NuqejZfKmeAjLXOFsf9BKAEB /94mvUTsNIgzB3POrzvCFnHXV7w4VBn5ZLJwExGKClJmcZktv4obsz9g27EUWUxFfIMd TFaljW7ZDfN+VpVIWQcBuqSVnFWOvK/5CzKGVuk6GHXCq8Z5kDB8lCmQ3n1dajFz36tA 4laA== X-Gm-Message-State: ACgBeo349pe8qggw3theJA05Hpsy692ARq2GM8OU/nr0n1XM41LBZ3Kw ZEWEkzzlC1N2Q3FurEyFVgw= X-Received: by 2002:ab0:3b0b:0:b0:397:d412:8575 with SMTP id n11-20020ab03b0b000000b00397d4128575mr2338572uaw.105.1660887184393; Thu, 18 Aug 2022 22:33:04 -0700 (PDT) Received: from localhost.localdomain ([2804:14c:4c2:8202::1001]) by smtp.gmail.com with ESMTPSA id w85-20020a1f9458000000b0037d0cd81996sm1999286vkd.37.2022.08.18.22.33.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Aug 2022 22:33:04 -0700 (PDT) From: Tales Aparecida To: Sadiya Kazi Cc: linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org, davidgow@google.com, 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, tales.aparecida@gmail.com Subject: [PATCH 5/8] Documentation: KUnit: add intro to the getting-started page Date: Fri, 19 Aug 2022 02:32:31 -0300 Message-Id: <20220819053234.241501-6-tales.aparecida@gmail.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220819053234.241501-1-tales.aparecida@gmail.com> References: <20220819053234.241501-1-tales.aparecida@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 --- Documentation/dev-tools/kunit/start.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst index f0ec64207bd3..3855402a5b3e 100644 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@ -4,6 +4,11 @@ Getting Started =============== +This page contains an overview about the kunit_tool and Kunit framework, +teaching how to run existent tests and then how to write a simple test-case, +and covering common problems users face when using Kunit for the first time. +It is recommended that the reader had compiled the Kernel at least once before. + Installing Dependencies ======================= KUnit has the same dependencies as the Linux kernel. As long as you can -- 2.37.1