From: Linus Torvalds Date: Tue, 11 Jan 2022 18:00:04 +0000 (-0800) Subject: Merge tag 'docs-5.17' of git://git.lwn.net/linux X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=6f38be8f2ccd9babf04b9b23539108542a59fcb8;p=linux.git Merge tag 'docs-5.17' of git://git.lwn.net/linux Pull documentation updates from Jonathan Corbet: "This isn't a hugely busy cycle for documentation, but a few significant things still showed up: - A documentation section for ARC processors - Reworked and enhanced KUnit documentation - The ability to pick your own theme for HTML builds; if the default "Read the Docs" theme isn't ugly enough for you, you can now pick an uglier one. - More Chinese translation work Plus the usual assortment of fixes and cleanups" * tag 'docs-5.17' of git://git.lwn.net/linux: (53 commits) scripts: sphinx-pre-install: Fix ctex support on Debian docs: discourage use of list tables docs: 5.Posting.rst: describe Fixes: and Link: tags Documentation: kgdb: Replace deprecated remotebaud docs: automarkup.py: Fix invalid HTML link output and broken URI fragments Documentation: refer to config RANDOMIZE_BASE for kernel address-space randomization Documentation: kgdb: properly capitalize the MAGIC_SYSRQ config docs/zh_CN: Update and fix a couple of typos scripts: sphinx-pre-install: add required ctex dependency Documentation: KUnit: Restyled Frequently Asked Questions Documentation: KUnit: Restyle Test Style and Nomenclature page Documentation: KUnit: Rework writing page to focus on writing tests Documentation: kunit: Reorganize documentation related to running tests Documentation: KUnit: Added KUnit Architecture Documentation: KUnit: Rewrite getting started Documentation: KUnit: Rewrite main page docs/zh_CN: Add zh_CN/accounting/delay-accounting.rst Documentation/sphinx: fix typos of "its" docs/zh_CN: Add sched-domains translation doc: fs: remove bdev_try_to_free_page related doc ... --- 6f38be8f2ccd9babf04b9b23539108542a59fcb8 diff --cc Documentation/dev-tools/kunit/start.rst index 0a5e65540974f,a858ab009944f..ad168d16968f5 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@@ -44,23 -59,19 +59,20 @@@ or ``VFAT_FS``. To run ``FAT_KUNIT_TEST CONFIG_LIST_KUNIT_TEST=y - :doc:`kunit_tool ` will ensure that all config options set in - ``.kunitconfig`` are set in the kernel ``.config`` before running the tests. - It'll warn you if you haven't included the dependencies of the options you're - using. + Before running the tests, kunit_tool ensures that all config options + set in ``.kunitconfig`` are set in the kernel ``.config``. It will warn + you if you have not included dependencies for the options used. - .. note:: + .. note :: - The configuration is only updated if the ``.kunitconfig`` is not a - subset of ``.config``. You can use tools (for example: - make menuconfig) to adjust other config options. + If you change the ``.kunitconfig``, kunit.py will trigger a rebuild of the + ``.config`` file. But you can edit the ``.config`` file directly or with + tools like ``make menuconfig O=.kunit``. As long as its a superset of + ``.kunitconfig``, kunit.py won't overwrite your changes. - - Running the tests (KUnit Wrapper) - --------------------------------- - - To make sure that everything is set up correctly, simply invoke the Python - wrapper from your kernel repo: + Running Tests (KUnit Wrapper) + ----------------------------- + 1. To make sure that everything is set up correctly, invoke the Python + wrapper from your kernel repository: .. code-block:: bash