Skip to content

KUnit documentation rewording

Bagas Sanjaya linux-doc linux-kselftest lkml 2 versions In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v1 Latest posting 2/27 patches 1 replyIn review
  2. v1 posting 1/27 patches 2 repliesSuperseded

Patches in v1 posting 2/2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/7Documentation: kunit: rewrite "Writing Your First Test" sectionDocumentation/dev-tools/kunit/start.rst+21 -130 replies
2/7Documentation: kunit: align instruction code blocksDocumentation/dev-tools/kunit/start.rst+10 -100 replies
3/7Documentation: kunit: rewrite the rest of "Getting Started" documentationDocumentation/admin-guide/README.rst Documentation/dev-tools/kunit/start.rst+93 -1190 replies
4/7Documentation: kunit: move introduction to its own documentDocumentation/dev-tools/kunit/index.rst Documentation/dev-tools/kunit/intro.rst+62 -920 replies
5/7Documentation: kunit: rewrite "Running tests with kunit_tool"Documentation/dev-tools/kunit/run_wrapper.rst+97 -2050 replies
6/7Documentation: kunit: rewrite "Run Tests without kunit_tool"Documentation/dev-tools/kunit/run_manual.rst+27 -410 replies
7/7Documentation: kunit: rewrite "Writing tests"Documentation/dev-tools/kunit/usage.rst+173 -1490 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH RESEND 0/7] KUnit documentation rewording

Hi everyone, sorry for quickly resending this patch series due to duplicated patch [7/7] sent as result of amending the corresponding commit.

The proses written in KUnit documentation are IMO incomprehensible (my brain has to process what the meaning of words used) and different from wordings that I normally read from technical writings. Thus, rewrite these using clearer words.

Anyway, it's great to see native English speakers help reviewing this series.

The first two patches are v3 of rewriting "Writing Your First Test" section of "Getting Started" patch [1], which was submitted about a month ago. The rest are actual documentation rewriting.

Note that this series only rewrites intro, test writing and running docs.

[1]: https://lore.kernel.org/lkml/[email protected]/

Bagas Sanjaya (7):
Documentation: kunit: rewrite "Writing Your First Test" section
Documentation: kunit: align instruction code blocks
Documentation: kunit: rewrite the rest of "Getting Started"
documentation
Documentation: kunit: move introduction to its own document
Documentation: kunit: rewrite "Running tests with kunit_tool"
Documentation: kunit: rewrite "Run Tests without kunit_tool"
Documentation: kunit: rewrite "Writing tests"

 Documentation/admin-guide/README.rst          |   2 +
 Documentation/dev-tools/kunit/index.rst       |  93 +----
 Documentation/dev-tools/kunit/intro.rst       |  61 ++++
 Documentation/dev-tools/kunit/run_manual.rst  |  68 ++--
 Documentation/dev-tools/kunit/run_wrapper.rst | 302 ++++++----------
 Documentation/dev-tools/kunit/start.rst       | 264 +++++++-------
 Documentation/dev-tools/kunit/usage.rst       | 322 ++++++++++--------
 7 files changed, 483 insertions(+), 629 deletions(-)
 create mode 100644 Documentation/dev-tools/kunit/intro.rst

base-commit: de3ee3f63400a23954e7c1ad1cb8c20f29ab6fe3

Signature · 1 line
An old man doll... just what I always wanted! - Clara