linux-kselftest.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Harinder Singh <sharinder@google.com>
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,
	Harinder Singh <sharinder@google.com>
Subject: [PATCH v1 0/7] Documentation: KUnit: Rework KUnit documentation
Date: Fri,  3 Dec 2021 04:24:30 +0000	[thread overview]
Message-ID: <20211203042437.740255-1-sharinder@google.com> (raw)

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.

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       | 165 ++---
 .../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       | 195 +++---
 Documentation/dev-tools/kunit/style.rst       | 101 ++--
 Documentation/dev-tools/kunit/usage.rst       | 570 ++++++++----------
 9 files changed, 1028 insertions(+), 586 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.0.384.gca35af8252-goog


             reply	other threads:[~2021-12-03  4:25 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-03  4:24 Harinder Singh [this message]
2021-12-03  4:24 ` [PATCH v1 1/7] Documentation: KUnit: Rewrite main page Harinder Singh
2021-12-03 17:32   ` Tim.Bird
2021-12-07  5:46     ` Harinder Singh
2021-12-03  4:24 ` [PATCH v1 2/7] Documentation: KUnit: Rewrite getting started Harinder Singh
2021-12-03 18:34   ` Tim.Bird
2021-12-07  5:53     ` Harinder Singh
2021-12-07 18:50       ` Tim.Bird
2021-12-03  4:24 ` [PATCH v1 3/7] Documentation: KUnit: Added KUnit Architecture Harinder Singh
2021-12-03  4:24 ` [PATCH v1 4/7] Documentation: kunit: Reorganize documentation related to running tests Harinder Singh
2021-12-03  4:24 ` [PATCH v1 5/7] Documentation: KUnit: Rework writing page to focus on writing tests Harinder Singh
2021-12-03  4:24 ` [PATCH v1 6/7] Documentation: KUnit: Restyle Test Style and Nomenclature page Harinder Singh
2021-12-03  4:24 ` [PATCH v1 7/7] Documentation: KUnit: Restyled Frequently Asked Questions Harinder Singh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211203042437.740255-1-sharinder@google.com \
    --to=sharinder@google.com \
    --cc=brendanhiggins@google.com \
    --cc=corbet@lwn.net \
    --cc=davidgow@google.com \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=shuah@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).