Google Git
Sign in
kunit / kunit-website / 09b6bcad154a504c9f04c1f90cdd71d05b86b1f6
commit09b6bcad154a504c9f04c1f90cdd71d05b86b1f6[log] [tgz]
authorSadiya Kazi <sadiyakazi@google.com>Thu Dec 22 09:21:45 2022 +0000
committerSadiya Kazi <sadiyakazi@google.com>Thu Dec 22 09:21:45 2022 +0000
tree82d8f780ddf88d25a9c489866e9c760ad0f0f590
parenteae155f1ed873f26bb4bbff7f45de7f64b0e99f2 [diff]
Documentation:Rename kunit_tool to kunit.py across

Change-Id: I399cd4fd3896f73bb38642b5fed1dc1a2926f49b
Signed-off-by: Sadiya Kazi <sadiyakazi@google.com>
2 files changed
tree: 82d8f780ddf88d25a9c489866e9c760ad0f0f590
  1. development/
  2. statics/
  3. third_party/
  4. usage/
  5. .gitignore
  6. conf.py
  7. CONTRIBUTING.md
  8. deploy.sh
  9. get_metrics.py
  10. index.rst
  11. LICENSE
  12. Makefile
  13. mocking.rst
  14. press.rst
  15. README.md
  16. release_notes.rst
README.md

KUnit Documentation

KUnit is a lightweight unit testing and mocking framework for the Linux kernel. These tests are able to be run locally on a developer’s workstation without a VM or special hardware.

KUnit is heavily inspired by JUnit, Python’s unittest.mock, and Googletest/Googlemock for C++. KUnit defines a way to mock out C style classes and functions and create expectations on methods called within the code under test.

This is a repository to host the source for the KUnit documentation.

NOTE: There is an important distinction between KUnit‘s documentation source and it’s documentation site. As a project meant primarily to serve the development of the Linux kernel, a significant portion of our code and documentation reside in the Linux kernel codebase. Consequently, the documentation that does not live in the Linux kernel follows many of the conventions of the Linux kernel. One of these conventions is that we use Sphinx for all of our documentation. Thus, because Sphinx requires documentation to be compiled from its source files, we must have a repository for all the Sphinx source files and a separate repository for all of the generated output files to actually host the site. This is the repository for the source.

Where is the code?

https://kunit.googlesource.com

How to build documentation

Documentation can be built by running:

make html

How to update the documentation

Our documentation is hosted at https://github.com/google/kunit-docs. The documentation may be updated by building the documentation as described above, and then:

./deploy.sh

You can copy the files over without committing and pushing the files with:

./deploy.sh --no-commit