kunit-tool.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. SPDX-License-Identifier: GPL-2.0
  2. =================
  3. kunit_tool How-To
  4. =================
  5. What is kunit_tool?
  6. ===================
  7. kunit_tool is a script (``tools/testing/kunit/kunit.py``) that aids in building
  8. the Linux kernel as UML (`User Mode Linux
  9. <http://user-mode-linux.sourceforge.net/>`_), running KUnit tests, parsing
  10. the test results and displaying them in a user friendly manner.
  11. kunit_tool addresses the problem of being able to run tests without needing a
  12. virtual machine or actual hardware with User Mode Linux. User Mode Linux is a
  13. Linux architecture, like ARM or x86; however, unlike other architectures it
  14. compiles the kernel as a standalone Linux executable that can be run like any
  15. other program directly inside of a host operating system. To be clear, it does
  16. not require any virtualization support: it is just a regular program.
  17. What is a .kunitconfig?
  18. =======================
  19. It's just a defconfig that kunit_tool looks for in the base directory.
  20. kunit_tool uses it to generate a .config as you might expect. In addition, it
  21. verifies that the generated .config contains the CONFIG options in the
  22. .kunitconfig; the reason it does this is so that it is easy to be sure that a
  23. CONFIG that enables a test actually ends up in the .config.
  24. How do I use kunit_tool?
  25. ========================
  26. If a kunitconfig is present at the root directory, all you have to do is:
  27. .. code-block:: bash
  28. ./tools/testing/kunit/kunit.py run
  29. However, you most likely want to use it with the following options:
  30. .. code-block:: bash
  31. ./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all`
  32. - ``--timeout`` sets a maximum amount of time to allow tests to run.
  33. - ``--jobs`` sets the number of threads to use to build the kernel.
  34. .. note::
  35. This command will work even without a .kunitconfig file: if no
  36. .kunitconfig is present, a default one will be used instead.
  37. For a list of all the flags supported by kunit_tool, you can run:
  38. .. code-block:: bash
  39. ./tools/testing/kunit/kunit.py run --help