commit | 67ff97f6e4751da0ed967c4376e035683bc21385 | [log] [tgz] |
---|---|---|
author | Daniel Latypov <dlatypov@google.com> | Thu Dec 02 15:00:01 2021 -0800 |
committer | Daniel Latypov <dlatypov@google.com> | Thu Dec 02 15:09:23 2021 -0800 |
tree | b641e0b2cd4720f754a310b49f822faf1658cbfa | |
parent | f469c21ae7221118533897b868ce6fa40b23159a [diff] |
release_notes.rst: add page summarizing changes for each Linux version Many of our uses don't have the luxury of developing on top of upstream Linux. So the question often arises, "can I use feature X and how painful would it be to backport?" This is intended to be a fairly terse representation of all the changes so that users don't have to go digging in git history to find what features landed when. They can guess at the backport difficulty now by looking at the version number. Change-Id: I957e8b0d1190a0882d60ee585ebb926036cce3c3 Signed-off-by: Daniel Latypov <dlatypov@google.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.
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