mbox series

[RESEND,0/7] KUnit documentation rewording

Message ID 20221023130846.63296-1-bagasdotme@gmail.com
Headers
Series KUnit documentation rewording |

Message

Bagas Sanjaya Oct. 23, 2022, 1:08 p.m. UTC 
  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/20220929132549.56452-1-bagasdotme@gmail.com/


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

Comments

Bagas Sanjaya Nov. 10, 2022, 4:09 a.m. UTC | #1 
On Sun, Oct 23, 2022 at 08:08:40PM +0700, Bagas Sanjaya wrote:
> 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/20220929132549.56452-1-bagasdotme@gmail.com/
> 

ping