tree: 9d86cca3255ce3524a038ccceaf8b433a3662d40 [path history] [tgz]
  1. .gitignore
  2. CONTRIBUTING.md
  3. LICENSE
  4. Makefile
  5. README.md
  6. conf.py
  7. development/
  8. index.rst
  9. statics/
  10. third_party/
  11. usage/
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 http://github.com/google/kunit-docs. The documentation may be updated by building the documentation as described above, and then:

git clone http://github.com/google/kunit-docs.git
cd kunit-docs/
git ls-files -z | xargs -0 rm -f
cp -r ../kunit-website/_build/html/. ./
git add -A
git commit
git push -u origin