Update website now that KUnit is upstream in 5.5
This fixes a few parts of the website which claim that KUnit is not
upstream, and instead directs people to the upstream kernel (noting that
5.5 or later is required).
The upstream documentation is now retrieved from torvalds/linux/master.
It also fixes a couple of links in the usage/getting_kunit page to the
documentation, which were broken.
Change-Id: Ifd6b53498cfaa9433232b0beba34ee6dca646d48
Signed-off-by: David Gow <davidgow@google.com>
diff --git a/Makefile b/Makefile
index 533b746..dfbec1b 100644
--- a/Makefile
+++ b/Makefile
@@ -48,7 +48,7 @@
$(call fetch_kernel_docs,https://kunit.googlesource.com/linux,kunit/alpha/master,$(BUILDDIR)/stable_kunit,stable_kernel,test)
fetch_upstream_docs:
- $(call fetch_kernel_docs,https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git,test,$(BUILDDIR)/upstream_kunit,kernel,dev-tools/kunit)
+ $(call fetch_kernel_docs,https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/,master,$(BUILDDIR)/upstream_kunit,kernel,dev-tools/kunit)
download_deps: fetch_stable_docs fetch_upstream_docs
diff --git a/index.rst b/index.rst
index a613894..5448044 100644
--- a/index.rst
+++ b/index.rst
@@ -76,8 +76,8 @@
Where do I get it?
==================
-- Upstream: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/log/?h=test
-- Stable: https://kunit.googlesource.com/linux/+/kunit/alpha/master
+- Upstream: https://www.kernel.org/ (version 5.5 or later)
+- Experimental: https://kunit.googlesource.com/linux/+/kunit/alpha/master
Not sure which one you want? Take a look at :doc:`usage/index`.
diff --git a/usage/getting_kunit.rst b/usage/getting_kunit.rst
index e70e96e..17317eb 100644
--- a/usage/getting_kunit.rst
+++ b/usage/getting_kunit.rst
@@ -79,16 +79,15 @@
Upstream
--------
-Alas, KUnit is not quite upstream yet. You can find the current to-be-upstreamed
-branch in the kselftest tree, but be warned that, until it's upstreamed, things
-may change at any point!
+KUnit can be found in Linux 5.5 and newer.
-- Code: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/log/?h=next
-- `Usage <third_party/kernel/docs/usage.html>`__ - for a more detailed explanation of KUnit features
-- `API <third_party/kernel/docs/api>`__ - for the list of KUnit APIs used for testing
+- Code: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/
+- `Usage <../third_party/kernel/docs/usage.html>`__ - for a more detailed explanation of KUnit features
+- `API <../third_party/kernel/docs/api>`__ - for the list of KUnit APIs used for testing
- kunitconfig file: https://kunit.googlesource.com/kunitconfig/+/refs/heads/master/kunitconfig
-You can also find KUnit in linux-next.
+The KUnit code itself is primarily found in the `lib/kunit <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/lib/kunit>`__
+directory.
Experimental
------------
@@ -99,6 +98,6 @@
is a historic *kunit/alpha/master* branch containing our experimental code.
- Code: https://kunit.googlesource.com/linux/+/kunit/alpha/master.
-- `Usage <third_party/stable_kernel/docs/usage.html>`__ - for a more detailed explanation of KUnit features
-- `API <third_party/stable_kernel/docs/api>`__ - for the list of KUnit APIs used for testing
+- `Usage <../third_party/stable_kernel/docs/usage.html>`__ - for a more detailed explanation of KUnit features
+- `API <../third_party/stable_kernel/docs/api>`__ - for the list of KUnit APIs used for testing
- kunitconfig file: https://kunit.googlesource.com/kunitconfig/+/refs/heads/kunit/alpha/master/kunitconfig
diff --git a/usage/index.rst b/usage/index.rst
index e7ec80b..a709747 100644
--- a/usage/index.rst
+++ b/usage/index.rst
@@ -81,18 +81,17 @@
=========================
Ideally, KUnit tests will be submitted upstream alongside the code being tested,
-so any user or developer can run the tests and test any changes they make. Once
-KUnit itself is upstream, this means that KUnit tests should ideally be treated
-as any other change, and submitted via the maintainer of the subsystem being
-tested. (Though do feel free to copy in the ``kunit-dev@googlegroups.com`` list
-if you want.)
+so any user or developer can run the tests and test any changes they make.
+Unless they affect KUnit itself, this means that KUnit tests should ideally be
+treated as any other change, and submitted via the maintainer of the subsystem
+being tested. (Though do feel free to copy in the
+``kunit-dev@googlegroups.com`` list if you want.)
-For the time being, though, we recommend submitting patches via the
-``linux-kselftest/test`` branch, which contains the version of KUnit likely to
+For changes to KUnit itself, we recommend submitting patches via the
+``linux-kselftest/kunit`` branch, which contains the version of KUnit likely to
head upstream. To do so, please send your patch via the
-``linux-kselftest@vger.kernel.org`` list, and include ``linux-kselftest/test``
-in the subject prefix. You should still get a review from the subsystem
-maintainer, though.
+``linux-kselftest@vger.kernel.org`` list. You should still get a review from
+any relevant the subsystem maintainers, though.
And, of course, you should follow the general rules and guidelines laid out in
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
