| commit | 6be65435727aa7b31676eb8e94e479147e1fd832 | [log] [tgz] |
|---|---|---|
| author | David Gow <davidgow@google.com> | Wed Aug 21 14:45:32 2024 +0800 |
| committer | David Gow <davidgow@google.com> | Thu Aug 22 21:40:35 2024 +0000 |
| tree | 21bbfa8a48e341dde13f53eaca1830df3f9c2808 | |
| parent | beae37ae7c93ea29f04c0eee48fcf197fb45a622 [diff] |
website: Remove 'stable' docs, link to kernel.org docs This is a rewrite of parts of the index page to remove references to the 'stable' version of KUnit (which hasn't been updated in nearly half a decade), and to link to the documentation on docs.kernel.org, rather than the copy on the website. It also fixes a few other outdated things, and links to the Kernel Testing Guide in a few places. It also stops attempting to generate the stable docs, as they don't build with modern versions of sphinx at all. Signed-off-by: David Gow <davidgow@google.com> Change-Id: I37e12116e9d8ddfdadd3fdf75b353af3e316e0a7
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.
https://kunit.googlesource.com
Documentation can be built by running:
make html
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