]> git.baikalelectronics.ru Git - kernel.git/commit
Documentation: kunit: Fix cross-referencing warnings
authorDavid Gow <davidgow@google.com>
Sat, 26 Mar 2022 05:44:15 +0000 (13:44 +0800)
committerJonathan Corbet <corbet@lwn.net>
Mon, 28 Mar 2022 21:36:41 +0000 (15:36 -0600)
commitbcf2e0d1400db302363f302c65cfe172482b49bc
tree7e7d0f72a628456ef3b2fc5447991f871fd4e30b
parent3e6841b07facefe4c4a00442eeafebd7e87edecb
Documentation: kunit: Fix cross-referencing warnings

The Architecture chapter of the KUnit documentation tried to include
copies of the kernel-doc for a couple of things, despite these already
existing in the API documentation. This lead to some warnings:

architecture:31: ./include/kunit/test.h:3: WARNING: Duplicate C declaration, also defined at dev-tools/kunit/api/test:66.
Declaration is '.. c:struct:: kunit_case'.
architecture:163: ./include/kunit/test.h:1217: WARNING: Duplicate C declaration, also defined at dev-tools/kunit/api/test:1217.
Declaration is '.. c:macro:: KUNIT_ARRAY_PARAM'.
architecture.rst:3: WARNING: Duplicate C declaration, also defined at dev-tools/kunit/api/test:66.
Declaration is '.. c:struct:: kunit_case'.
architecture.rst:1217: WARNING: Duplicate C declaration, also defined at dev-tools/kunit/api/test:1217.
Declaration is '.. c:macro:: KUNIT_ARRAY_PARAM'.

Get rid of these, and cleanup the mentions of the struct and macro in
question so that sphinx generates a link to the existing copy of the
documentation in the api/test document.

Fixes: 01f959e51585 ("Documentation: KUnit: Added KUnit Architecture")
Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Tested-by: Brendan Higgins <brendanhiggins@google.com>
Link: https://lore.kernel.org/r/20220326054414.637293-1-davidgow@google.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/dev-tools/kunit/architecture.rst