release_notes: add explicit section names for each release
This should give us links like
https://kunit.dev/release_notes.html#v5-18
instead of
https://kunit.dev/release_notes.html#id14
By experimentation, it looks like it's not possible to get #5.5 or #v5.5
While the final result is not ideal, it's still a lot more human
friendly than "id$N".
Change-Id: I7ac7983cd3d08ea678ef048e7eb081ce82f7d14d
Signed-off-by: Daniel Latypov <dlatypov@google.com>
diff --git a/release_notes.rst b/release_notes.rst
index 4766d7f..77dd91b 100644
--- a/release_notes.rst
+++ b/release_notes.rst
@@ -7,6 +7,8 @@
For more specific documentation on KUnit features, see the in-kernel
documentation: https://kernel.org/doc/html/latest/dev-tools/kunit.
+.. _v5.5:
+
5.5
===
@@ -14,12 +16,16 @@
- ``kunitconfig`` was renamed to ``.kunitconfig`` later in in 5.5 (`commit
<https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=14ee5cfd4512ee3d1e0047d8751450dcc6544070>`__)
+.. _v5.6:
+
5.6
===
- KUnit tests can be built as modules, `docs
<https://www.kernel.org/doc/html/latest/dev-tools/kunit/running_tips.html#running-tests-as-modules>`__
+.. _v5.7:
+
5.7
===
@@ -29,6 +35,8 @@
``/sys/kernel/debug/kunit/<suite>/results``, `docs
<https://www.kernel.org/doc/html/latest/dev-tools/kunit/running_tips.html#retrieving-per-suite-results>`__
+.. _v5.8:
+
5.8
===
@@ -57,6 +65,8 @@
<https://www.kernel.org/doc/html/latest/dev-tools/kunit/style.html#test-kconfig-entries>`__
for the authoritative source on how to write Kconfig entries.
+.. _v5.9:
+
5.9
===
@@ -68,6 +78,8 @@
<https://elixir.bootlin.com/linux/latest/source/lib/test_kasan.c>`__ for an
example that uses ``"kasan_data"``.
+.. _v5.10:
+
5.10
====
@@ -75,12 +87,16 @@
- Note: KASAN doesn't currently work on UML.
+.. _v5.11:
+
5.11
====
- Parameterized testing: see the `docs
<https://www.kernel.org/doc/html/latest/dev-tools/kunit/usage.html#parameterized-testing>`__.
+.. _v5.12:
+
5.12
====
@@ -99,6 +115,7 @@
# Only run "list" suites
$ ./tools/testing/kunit/kunit.py run '*list*'
+.. _v5.13:
5.13
====
@@ -108,6 +125,8 @@
- You can pass a directory ``--kunitconfig`` and it'll implicitly append
``.kunitconfig``, e.g. ``kunit.py run --kunitconfig=lib/kunit``.
+.. _v5.14:
+
5.14
====
@@ -118,6 +137,8 @@
- Tests can call ``kunit_skip()`` to bail out and mark a test as "SKIPPED"
instead of "PASSED" or "FAILED"
+.. _v5.15:
+
5.15
====
@@ -131,6 +152,8 @@
# property-entry: pass:7 fail:0 skip:0 total:7
+.. _v5.16:
+
5.16
====
@@ -160,6 +183,8 @@
- In-kernel documentation has been significantly revamped.
+.. _v5.17:
+
5.17
====
@@ -191,6 +216,7 @@
[12:37:14] ================= [PASSED] ext4_inode_test =================
[12:37:14] ============================================================
+.. _v5.18:
5.18
====
@@ -202,6 +228,8 @@
- Now on UML (x86_64), ``KUNIT_EXPECT_EQ()`` uses 32 bytes instead of 88.
+.. _v5.19:
+
5.19 (tentative)
================
