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 02919C4332F for ; Fri, 17 Dec 2021 04:37:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231838AbhLQEhs (ORCPT ); Thu, 16 Dec 2021 23:37:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48636 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231819AbhLQEhq (ORCPT ); Thu, 16 Dec 2021 23:37:46 -0500 Received: from mail-yb1-xb4a.google.com (mail-yb1-xb4a.google.com [IPv6:2607:f8b0:4864:20::b4a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BB713C06173E for ; Thu, 16 Dec 2021 20:37:46 -0800 (PST) Received: by mail-yb1-xb4a.google.com with SMTP id g36-20020a25ae64000000b005c1f46f7ee6so2528899ybe.8 for ; Thu, 16 Dec 2021 20:37:46 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=date:message-id:mime-version:subject:from:to:cc; bh=xelJswVre1tYVahXwKTZOkblh1Y4r9luAnX/6Rww7JE=; b=eX/gEAi3fmbR2axSllp1ltD6tZwIvalFemFA9465+8cAbjsYszkgeAdmOgioNJ2X2X NiPRr8qTLz97za3yorX1oT3EEXMma7QnpDRX8I2HpEjwneXLlKi1sqL8cXP/bKE+wWIp Quv9+kSv5Gylr/n/KjZedeXhm/D/MIfjEcoV7QrFN+SUhFRQ3S/aaPpTdoeXPZaS9pCy B0f+4sMcNDZRpNQkmj/oG+qCnWvrfd3o9n1xTPxr+0WaEhJFC2MiBRbvylxXAU08/jqq 8U6xWdwuZKqmvZizNHxdWz67+zVg0yMr+jou6PCB6D4SUMopD6bG176pc2QHXDfgFlb6 Svew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:message-id:mime-version:subject:from:to:cc; bh=xelJswVre1tYVahXwKTZOkblh1Y4r9luAnX/6Rww7JE=; b=QAxkvDCPtWNYArRdhBV81u3PHgkK+PiiqrIY49JsfEg8syqNNI90ACOGaGAkOyxnnT ISVHycuiRvRuj37xqMk3aW0U0N68OH/HLU0Tnz62WusU3vpsGO4ljMZQmhF85Glab+qH nc1hflJ4NDf9vqNNRd0tI5Nup3lQhnlKCoc2TDnSGLmMeKbBFaUOBnl08PC3myv79Xfq XtfEs7p7DNuTp5dmsoDa2Cm8RYWDJ6dgac2tu6032h4XVC6veELrNxYg3BV5gsrjLPHO qSe9u8nqopYuS101aCbB0z47E1j7QyHSFU6ZPlUE4ItP/n3fyeKVPZZrlXg4YSm3qJV+ KQdA== X-Gm-Message-State: AOAM533qBXBAUfzCqjOnoUTj2Eg6howAaHEq44JxTzD1BlT+1O+AAZ03 3kaqzv4aKBAAbuG/0iVejxWD060nn+xu+44= X-Google-Smtp-Source: ABdhPJxgCYj9kdrU/L7Nuux6pjcDbHKf3PY2daVPoyx3heNOB4dNiDJ6MXuc05/WZcRWeFs4CNHfcPga2Ho96uU= X-Received: from sharinder.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:c73]) (user=sharinder job=sendgmr) by 2002:a25:42d7:: with SMTP id p206mr1996514yba.765.1639715865881; Thu, 16 Dec 2021 20:37:45 -0800 (PST) Date: Fri, 17 Dec 2021 04:37:09 +0000 Message-Id: <20211217043716.794289-1-sharinder@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.34.1.173.g76aa8bc2d0-goog Subject: [PATCH v5 0/7] Documentation: KUnit: Rework KUnit documentation From: Harinder Singh To: davidgow@google.com, brendanhiggins@google.com, shuah@kernel.org, corbet@lwn.net Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, tim.bird@sony.com, elver@google.com, Harinder Singh Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The KUnit documentation was not very organized. There was little information related to KUnit architecture and the importance of unit testing. Add some new pages, expand and reorganize the existing documentation. Reword pages to make information and style more consistent. Changes since v4: https://lore.kernel.org/linux-kselftest/20211216055958.634097-1-sharinder@google.com/T/ -- Replaced kunit_suitememorydiagram.png with kunit_suitememorydiagram.svg Changes since v3: https://lore.kernel.org/linux-kselftest/20211210052812.1998578-1-sharinder@google.com/T/#m0a85e6a36f13c66470844d92553d19c19239ebed --Reworded sentences as per comments --Replaced Elixir links with kernel.org links or kernel-doc references Changes since v2: https://lore.kernel.org/linux-kselftest/20211207054019.1455054-1-sharinder@google.com/T/ --Reworded sentences as per comments --Expanded the explaination in usage.rst for accessing the current test example --Standardized on US english in style.rst Changes since v1: https://lore.kernel.org/linux-kselftest/20211203042437.740255-1-sharinder@google.com/ --Fixed spelling mistakes --Restored paragraph about kunit_tool introduction --Added note about CONFIG_KUNIT_ALL_TESTS (Thanks Tim Bird for review comments) -- Miscellaneous changes Harinder Singh (7): Documentation: KUnit: Rewrite main page Documentation: KUnit: Rewrite getting started Documentation: KUnit: Added KUnit Architecture Documentation: kunit: Reorganize documentation related to running tests Documentation: KUnit: Rework writing page to focus on writing tests Documentation: KUnit: Restyle Test Style and Nomenclature page Documentation: KUnit: Restyled Frequently Asked Questions .../dev-tools/kunit/architecture.rst | 204 +++++++ Documentation/dev-tools/kunit/faq.rst | 73 ++- Documentation/dev-tools/kunit/index.rst | 172 +++--- Documentation/dev-tools/kunit/run_manual.rst | 57 ++ Documentation/dev-tools/kunit/run_wrapper.rst | 247 ++++++++ Documentation/dev-tools/kunit/start.rst | 198 +++--- Documentation/dev-tools/kunit/style.rst | 105 ++-- Documentation/dev-tools/kunit/usage.rst | 578 ++++++++---------- 8 files changed, 1047 insertions(+), 587 deletions(-) create mode 100644 Documentation/dev-tools/kunit/architecture.rst create mode 100644 Documentation/dev-tools/kunit/run_manual.rst create mode 100644 Documentation/dev-tools/kunit/run_wrapper.rst base-commit: 4c388a8e740d3235a194f330c8ef327deef710f6 -- 2.34.1.173.g76aa8bc2d0-goog