linux-stable.git/Documentation/dev-tools/kunit/start.rst, branch linux-6.2.y

Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections

2022-12-12T21:13:48+00:00

The "How Do I Use This" section of index.rst and "Next Steps" section of
start.rst were just copies of the table of contents, and therefore
weren't really useful either when looking a sphinx generated output
(which already had the TOC visible) or when reading the source (where
it's just a list of files that ls could give you).

Instead, provide a small number of concrete next steps, and a bit more
description about what the pages contain.

This also removes the broken reference to 'tips.rst', which was
previously removed.

Fixed git am whitespace complaints during commit:
Shuah Khan 

Fixes: 4399c737a97d ("Documentation: kunit: Remove redundant 'tips.rst' page")
Signed-off-by: David Gow 
Reviewed-by: Sadiya Kazi 
Reviewed-by: Bagas Sanjaya 
Signed-off-by: Shuah Khan

Documentation: Kunit: Use full path to .kunitconfig

2022-09-30T19:23:06+00:00

The numbered list contains full path to every files that need to be
modified or created in order to implement misc-example kunit test.
Except for .kunitconfig. Which might make a newcommer confused about
where the file exists. Since there are multiple .kunitconfig files.

Fix this by using the full path to .kunitconfig.

Signed-off-by: Khalid Masum 
Reviewed-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: KUnit: add intro to the getting-started page

2022-09-30T19:21:02+00:00

Describe the objective of the Getting Started page, which should be a
brief and beginner-friendly walkthrough for running and writing tests,
showing the reader where to find detailed instructions in other pages.

Signed-off-by: Tales Aparecida 
Reviewed-by: Maíra Canal 
Reviewed-by:Sadiya Kazi
Reviewed-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: KUnit: Reword start guide for selecting tests

2022-09-30T19:20:57+00:00

Reword "Creating a ``.kunitconfig``" into "Selecting which tests to run"
covering the current alternatives for editing configs and glob-filtering

Signed-off-by: Tales Aparecida 
Reviewed-by: Maíra Canal 
Reviewed-by:Sadiya Kazi 
Reviewed-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: KUnit: add note about mrproper in start.rst

2022-09-30T19:20:51+00:00

The "Getting Started" guide should be beginner-friendly, therefore
add a note about the requirement of a clean source tree when running
kunit_tool for the first time, and its related error.

Signed-off-by: Tales Aparecida 
Reviewed-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: KUnit: avoid repeating "kunit.py run" in start.rst

2022-09-30T19:20:42+00:00

Combine two sections mentioning "kunit.py run" to streamline the
getting-started guide. Update "kunit.py run" expected output in
the guide and run_wrapper.

Signed-off-by: Tales Aparecida 
Reviewed-by: Maíra Canal 
Reviewed-by: Sadiya Kazi
Reviewed-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: KUnit: remove duplicated docs for kunit_tool

2022-09-30T19:20:33+00:00

Delete "kunit-tool.rst" to remove repeated info from KUnit docs.
"What is kunit_tool?" was integrated into index.rst, the remaining
sections were moved into run_wrapper.rst and renamed as follows:

"What is a .kunitconfig?" -> "Creating a ``.kunitconfig`` file"
"Getting Started with kunit_tool" -> "Running tests with kunit_tool"
"Configuring, Building, and Running Tests" ->
	"Configuring, building, and running tests"
"Running Tests on QEMU" -> "Running tests on QEMU"
"Parsing Test Results" -> "Parsing test results"
"Filtering Tests" -> "Filtering tests"
"Other Useful Options" -> "Running command-line arguments"

Signed-off-by: Tales Aparecida 
Reviewed-by: Sadiya Kazi 
Reviewed-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: kunit: fix path to .kunitconfig in start.rst

2022-04-04T18:02:44+00:00

Commit ddbd60c779b4 ("kunit: use --build_dir=.kunit as default") changed
the default --build_dir, which had the side effect of making
`.kunitconfig` move to `.kunit/.kunitconfig`.

However, the first few lines of kunit/start.rst never got updated, oops.

Fix this by telling people to run kunit.py first, which will
automatically generate the .kunit directory and .kunitconfig file, and
then edit the file manually as desired.

Reported-by: Yifan Yuan 
Signed-off-by: Daniel Latypov 
Reviewed-by: David Gow 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

Merge tag 'docs-5.17' of git://git.lwn.net/linux

2022-01-11T18:00:04+00:00

Pull documentation updates from Jonathan Corbet:
 "This isn't a hugely busy cycle for documentation, but a few
  significant things still showed up:

   - A documentation section for ARC processors

   - Reworked and enhanced KUnit documentation

   - The ability to pick your own theme for HTML builds; if the default
     "Read the Docs" theme isn't ugly enough for you, you can now pick
     an uglier one.

   - More Chinese translation work

  Plus the usual assortment of fixes and cleanups"

* tag 'docs-5.17' of git://git.lwn.net/linux: (53 commits)
  scripts: sphinx-pre-install: Fix ctex support on Debian
  docs: discourage use of list tables
  docs: 5.Posting.rst: describe Fixes: and Link: tags
  Documentation: kgdb: Replace deprecated remotebaud
  docs: automarkup.py: Fix invalid HTML link output and broken URI fragments
  Documentation: refer to config RANDOMIZE_BASE for kernel address-space randomization
  Documentation: kgdb: properly capitalize the MAGIC_SYSRQ config
  docs/zh_CN: Update and fix a couple of typos
  scripts: sphinx-pre-install: add required ctex dependency
  Documentation: KUnit: Restyled Frequently Asked Questions
  Documentation: KUnit: Restyle Test Style and Nomenclature page
  Documentation: KUnit: Rework writing page to focus on writing tests
  Documentation: kunit: Reorganize documentation related to running tests
  Documentation: KUnit: Added KUnit Architecture
  Documentation: KUnit: Rewrite getting started
  Documentation: KUnit: Rewrite main page
  docs/zh_CN: Add zh_CN/accounting/delay-accounting.rst
  Documentation/sphinx: fix typos of "its"
  docs/zh_CN: Add sched-domains translation
  doc: fs: remove bdev_try_to_free_page related doc
  ...

Documentation: KUnit: Rework writing page to focus on writing tests

2021-12-23T19:49:43+00:00

We now have dedicated pages on running tests. Therefore refocus the
usage page on writing tests and add content from tips page and
information on other architectures.

Signed-off-by: Harinder Singh 
Reviewed-by: Tim Bird 
Reviewed-by: Brendan Higgins 
Link: https://lore.kernel.org/r/20211217044911.798817-6-sharinder@google.com
Signed-off-by: Jonathan Corbet