Received: by 2002:a05:6358:5282:b0:b5:90e7:25cb with SMTP id g2csp1868479rwa; Sun, 21 Aug 2022 19:49:04 -0700 (PDT) X-Google-Smtp-Source: AA6agR77TOlhkO9w0cpe/BYMXHaaLZALONcNbowH6fP6c4plVjtBvTQQ1HLbd7JpZNpGSbh3Bsk7 X-Received: by 2002:a17:90b:3b43:b0:1f4:e3ad:e45a with SMTP id ot3-20020a17090b3b4300b001f4e3ade45amr26524355pjb.87.1661136544492; Sun, 21 Aug 2022 19:49:04 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1661136544; cv=none; d=google.com; s=arc-20160816; b=Wwcn4ssrrkQxhBInELilKrPrH9kewqCznFWasNAvh8f9Uz5N/fP+aAbdz1xI4rF7cP UqN0XIZKA29LkPYRtEoA1tmLrC60S77LHnb+jTDBhNJ5B43olupNZjTyom9JHfpO70Ks W1SALYlwBjA+KvbpN27wU1PrUy2kDyW/ISFQ4k90qOt/gH0d28+knrkKI3FDg8H44B74 rSItjKOeHLFmYlfwicoGn2VM0uhtmFQrFT93mVzrezCZwTNMf0ldKuATQRjBuR41bHVq UiiWMkMsrxdj6MJGFSuhQmu0riuZTa4tLBkAIcue2fM+tCgOb17OQ4D1Ho/zI4HwF0AC BmbA== 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=Rcr+UWvpwFsX5wSj0zFjllGRLda0UFgn1uun5gueN54=; b=lB8dshPEonPeGw+73IyzUw3JUepkSQ1hef5OuoZJnZl5yOmrG5/vztoPy4GPamokIY 5jdhXp5QJj3wL7v//QLHSYYf4NYtjg9+VMKs7ikDUXbOWqcteWXVN/rZ4SGDDXL5aw2V k2jU4k19FdL2l2s80YOTDE3KZrhLfprrfKOm0AnWZfEWRFXqyMNn5BeprMKyX2Qwr3E+ kVaVGMPjlj3uIw+RicZFWy0f3fj1U9RCxkOIsZMt9RKjdPSOHxXGcwoHRZfV1o43KEF8 B3PffalB+mGbN9YgitLt2pauwGn5UkK3dM1d+8bEnmKs3hqR9HCdwMTrLrtK/V5mwRGf bauQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=iRa7nBPV; 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 mh1-20020a17090b4ac100b001fa92c95266si12291515pjb.172.2022.08.21.19.48.53; Sun, 21 Aug 2022 19:49:04 -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=iRa7nBPV; 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 S232570AbiHVCbH (ORCPT + 99 others); Sun, 21 Aug 2022 22:31:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34258 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232442AbiHVCan (ORCPT ); Sun, 21 Aug 2022 22:30:43 -0400 Received: from mail-vs1-xe36.google.com (mail-vs1-xe36.google.com [IPv6:2607:f8b0:4864:20::e36]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2ABC1220E2; Sun, 21 Aug 2022 19:30:43 -0700 (PDT) Received: by mail-vs1-xe36.google.com with SMTP id l7so9535043vsc.0; Sun, 21 Aug 2022 19:30:43 -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=Rcr+UWvpwFsX5wSj0zFjllGRLda0UFgn1uun5gueN54=; b=iRa7nBPVQ5ieSVV1SEsOAgeorDjhvJIj97P/ytmGKL1DZEFV7tVA0vA05SFAqI2Pp4 9UzZZnmN2FWpDN9VuiRY2cw9JSq6weyc1OZTVbGtffiY7HohaPqTuS05rOcGZIsqUX0Z RTmJ03PXzB7P3bT4W0+jZq7u9rJKpEuVGw8cKIZW4H1AsQQGTmS/R0U/bwLIJwGfR95Q NSbByhx88Ml8Dr206INUbAwVWyGmwkJsNNHZ9wVLM+RySnuycIDPgEO4U4H/JS7T3Fb6 DHsyIAzJEJGw7Ge8ZvU/h9eNL3k4Hy7RsixMSgihINwl80ibekP/tQJxK9MyoEVqHsPW vFWQ== 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=Rcr+UWvpwFsX5wSj0zFjllGRLda0UFgn1uun5gueN54=; b=ZmyOsg0KzVYqFCEYtPNDg9nDOox0brmCN2vmzqDafB57sP2bRZa6mr9Zu3dl13PazH r1++xQDJqLSDJDkRHRu5AhhmZnM5DrTwHSl/IUMZYDkXmTJNFh+0sf48L4LBCEoi5Hgs eu7D4L+67GxzUTcBgKDrkdk/fXhaeucJj5qdqh8MsL8WQANiSW9zwPafHSOhb4j+QOvR 6IGIP1yZCBcanOh4orAvyViJzZ4xyUidZH3W3nMvfpvP67yVaKa3ovcArPqa2nBTveWz eWn60iACEMeczYAR9a1R3FvbUf8jJwVj8F4lBkUAIeT26xTFHbuI8b7Syp0EZjL6oYoS pejg== X-Gm-Message-State: ACgBeo1NHNnktn04yOLKdbQZoUx75JIx4DB0fDswcBORe/dASInxCg+y fpO9fMF/z52P7aqPV6plUvUzPEPMyMTHMA== X-Received: by 2002:a67:d483:0:b0:38f:4981:c4f3 with SMTP id g3-20020a67d483000000b0038f4981c4f3mr5962663vsj.59.1661135442235; Sun, 21 Aug 2022 19:30:42 -0700 (PDT) Received: from localhost.localdomain ([2804:14c:4c2:8202::1001]) by smtp.gmail.com with ESMTPSA id y125-20020a1f3283000000b00378fe8518dcsm8330853vky.51.2022.08.21.19.30.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 21 Aug 2022 19:30:41 -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 v2 6/8] Documentation: KUnit: update links in the index page Date: Sun, 21 Aug 2022 23:26:44 -0300 Message-Id: <20220822022646.98581-7-tales.aparecida@gmail.com> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20220822022646.98581-1-tales.aparecida@gmail.com> References: <20220822022646.98581-1-tales.aparecida@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 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 Replace out-of-date external links with references to the kernel documentation, replacing TAP webpage for the more appropriate KTAP documentation and the UML webpage by its documentation. Signed-off-by: Tales Aparecida --- Documentation/dev-tools/kunit/index.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst index d7187282ba28..f5d13f1d37be 100644 --- a/Documentation/dev-tools/kunit/index.rst +++ b/Documentation/dev-tools/kunit/index.rst @@ -28,10 +28,10 @@ KUnit (Kernel unit testing framework) provides a common framework for unit tests within the Linux kernel. Using KUnit, you can define groups of test cases called test suites. The tests either run on kernel boot if built-in, or load as a module. KUnit automatically flags and reports -failed test cases in the kernel log. The test results appear in `TAP -(Test Anything Protocol) format `_. It is inspired by -JUnit, Python’s unittest.mock, and GoogleTest/GoogleMock (C++ unit testing -framework). +failed test cases in the kernel log. The test results appear in +:doc:`KTAP (Kernel - Test Anything Protocol) format`. +It is inspired by JUnit, Python’s unittest.mock, and GoogleTest/GoogleMock +(C++ unit testing framework). KUnit tests are part of the kernel, written in the C (programming) language, and test parts of the Kernel implementation (example: a C @@ -45,8 +45,9 @@ internal system functionality. KUnit runs in kernel space and is not restricted to things exposed to user-space. In addition, KUnit has kunit_tool, a script (``tools/testing/kunit/kunit.py``) -that configures the Linux kernel, runs KUnit tests under QEMU or UML (`User Mode -Linux `_), parses the test results and +that configures the Linux kernel, runs KUnit tests under QEMU or UML +(:doc:`User Mode Linux `), +parses the test results and displays them in a user friendly manner. Features -- 2.37.2