|author||David Gow <firstname.lastname@example.org>||Thu Mar 12 09:57:12 2020 -0700|
|committer||David Gow <email@example.com>||Thu Mar 12 09:57:12 2020 -0700|
Update the upstream documentation landing page. This page previously was pointing to the old kselftest/test branch, which (a) is no longer used, and (b) isn't even where we're getting the mirrored documentation. Replaced it with a link to the torvalds master branch, which is where the documentation mirror is copied from. I've also linked to the kselftest/kunit branch, which is where most development happens, and to the kunit documentation 'latest' version on kernel.org as a mirror. Change-Id: I8d25487e049c5e0867498ace32f90ce880b3395f
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 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