| Message ID | 20211217044911.798817-1-sharinder@google.com (mailing list archive) |
|---|---|
| Headers | show |
| Series | Documentation: KUnit: Rework KUnit documentation | expand |
On Thu, Dec 16, 2021 at 11:49 PM Harinder Singh <sharinder@google.com> wrote: > > 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. Thanks for all your hard work on this Harinder! And thanks to everyone else (Tim, Marco, and David) for all of your help on this! Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Harinder Singh <sharinder@google.com> writes: > 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. Series applied, thanks. jon
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 v5: https://lore.kernel.org/linux-kselftest/20211217043716.794289-1-sharinder@google.com/T/ -- Forgot to add the new .svg diagram file to git. 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 +++--- .../kunit/kunit_suitememorydiagram.svg | 81 +++ 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 ++++++++---------- 9 files changed, 1128 insertions(+), 587 deletions(-) create mode 100644 Documentation/dev-tools/kunit/architecture.rst create mode 100644 Documentation/dev-tools/kunit/kunit_suitememorydiagram.svg create mode 100644 Documentation/dev-tools/kunit/run_manual.rst create mode 100644 Documentation/dev-tools/kunit/run_wrapper.rst base-commit: 4c388a8e740d3235a194f330c8ef327deef710f6