|author||Brendan Higgins <email@example.com>||Mon Nov 11 17:04:40 2019 -0800|
|committer||Brendan Higgins <firstname.lastname@example.org>||Mon Nov 11 17:07:17 2019 -0800|
Fix malformed doc link in development getting started doc Fix malformed link. Originally it was a resource style link, but it should be a doc style link. Change-Id: Ia7f4b23d20d1367a8621c4da178266a1fe515afb Signed-off-by: Brendan Higgins <email@example.com>
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