Documentation: kunit: Cleanup run_wrapper, fix x-ref
authorDavid Gow <davidgow@google.com>
Wed, 29 Jun 2022 04:06:05 +0000 (12:06 +0800)
committerShuah Khan <skhan@linuxfoundation.org>
Fri, 8 Jul 2022 17:36:03 +0000 (11:36 -0600)
commit7635778bac7e46458392c1261e3916e8e9e86860
tree7d0d7fc35265902fc2a2f7c4574dc303ab6bd919
parent7b2379454b9a72fece618319acea8d33497d2299
Documentation: kunit: Cleanup run_wrapper, fix x-ref

The "Run Tests on qemu" section of run_wrapper.rst had a few issues left
over from the last big documentation refactor[1]:
- It referenced a non_uml.rst page, which was integrated into the other
  pages (including run_wrapper.rst).
- It skimmed over the use of --arch= and --cross_compile= in favour of
  using a custom --qemu_config. Since most users will want to use the
  former, let's give examples.

Remove the reference to the non-existant page, and add a couple of
examples to encourage the use of --arch= and --cross_compile=.

With this change, there should be no more broken references in the KUnit
documentation (i.e., the one mentioned in [2] is gone).

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=46201d47d6c4be594c1d57b7f3251c371626a9c4
[2]: https://lore.kernel.org/linux-doc/cover.1656234456.git.mchehab@kernel.org/

Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/kunit/run_wrapper.rst