|author||Daniel Latypov <firstname.lastname@example.org>||Tue Dec 14 09:48:22 2021 -0800|
|committer||Daniel Latypov <email@example.com>||Tue Dec 14 22:34:04 2021 +0000|
minor: de-emphasize Gerrit in development/ docs For ~everyone reading these docs, they should send KUnit patches directly to upstream. Move out all the stuff about Gerrit and CLAs to its own page so as not to confuse these readers. The only KUnit use of Gerrit right now is: * for this website itself * for the prow presubmit * very rarely: as a staging ground for bigger changes * e.g. the parser rewrite and QEMU support * but we don't actually update the kunit gerrit repo often, so you have to either work on an old base or pester someone to update it. Change-Id: I2c29aef82f7cfc80407f4c58d295009e99742d68 Signed-off-by: Daniel Latypov <firstname.lastname@example.org>
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.
Documentation can be built by running:
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:
You can copy the files over without committing and pushing the files with: