* [PATCH v3 0/7] Documentation: KUnit: Rework KUnit documentation
@ 2021-12-16 5:58 Harinder Singh
2021-12-16 6:02 ` Harinder Singh
0 siblings, 1 reply; 3+ messages in thread
From: Harinder Singh @ 2021-12-16 5:58 UTC (permalink / raw)
To: davidgow, brendanhiggins, shuah, corbet
Cc: linux-kselftest, kunit-dev, linux-doc, linux-kernel, tim.bird,
elver, Harinder Singh
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 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 | 206 +++++++
Documentation/dev-tools/kunit/faq.rst | 73 ++-
Documentation/dev-tools/kunit/index.rst | 172 +++---
.../kunit/kunit_suitememorydiagram.png | Bin 0 -> 24174 bytes
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, 1049 insertions(+), 587 deletions(-)
create mode 100644 Documentation/dev-tools/kunit/architecture.rst
create mode 100644 Documentation/dev-tools/kunit/kunit_suitememorydiagram.png
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v3 0/7] Documentation: KUnit: Rework KUnit documentation
2021-12-16 5:58 [PATCH v3 0/7] Documentation: KUnit: Rework KUnit documentation Harinder Singh
@ 2021-12-16 6:02 ` Harinder Singh
0 siblings, 0 replies; 3+ messages in thread
From: Harinder Singh @ 2021-12-16 6:02 UTC (permalink / raw)
To: David Gow, Brendan Higgins, shuah, corbet
Cc: linux-kselftest, kunit-dev, linux-doc, linux-kernel, tim.bird, elver
Hello everyone,
Sorry by mistake I sent old patch.
Please ignore.
Thanks,
Harinder Singh
On Thu, Dec 16, 2021 at 11:29 AM 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.
>
> 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 | 206 +++++++
> Documentation/dev-tools/kunit/faq.rst | 73 ++-
> Documentation/dev-tools/kunit/index.rst | 172 +++---
> .../kunit/kunit_suitememorydiagram.png | Bin 0 -> 24174 bytes
> 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, 1049 insertions(+), 587 deletions(-)
> create mode 100644 Documentation/dev-tools/kunit/architecture.rst
> create mode 100644 Documentation/dev-tools/kunit/kunit_suitememorydiagram.png
> 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
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v3 0/7] Documentation: KUnit: Rework KUnit documentation
@ 2021-12-10 5:28 Harinder Singh
0 siblings, 0 replies; 3+ messages in thread
From: Harinder Singh @ 2021-12-10 5:28 UTC (permalink / raw)
To: davidgow, brendanhiggins, shuah, corbet
Cc: linux-kselftest, kunit-dev, linux-doc, linux-kernel, tim.bird,
Harinder Singh
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 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 | 206 +++++++
Documentation/dev-tools/kunit/faq.rst | 73 ++-
Documentation/dev-tools/kunit/index.rst | 172 +++---
.../kunit/kunit_suitememorydiagram.png | Bin 0 -> 24174 bytes
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, 1049 insertions(+), 587 deletions(-)
create mode 100644 Documentation/dev-tools/kunit/architecture.rst
create mode 100644 Documentation/dev-tools/kunit/kunit_suitememorydiagram.png
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-12-16 6:02 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-16 5:58 [PATCH v3 0/7] Documentation: KUnit: Rework KUnit documentation Harinder Singh
2021-12-16 6:02 ` Harinder Singh
-- strict thread matches above, loose matches on Subject: below --
2021-12-10 5:28 Harinder Singh
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).