linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: David Gow <davidgow@google.com>,
	Brendan Higgins <brendanhiggins@google.com>
Cc: David Gow <davidgow@google.com>, Marco Elver <elver@google.com>,
	Daniel Latypov <dlatypov@google.com>,
	skhan@linuxfoundation.org, kunit-dev@googlegroups.com,
	linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: kunit: Fix cross-referencing warnings
Date: Mon, 28 Mar 2022 14:02:51 -0600	[thread overview]
Message-ID: <87r16l7slw.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220326054414.637293-1-davidgow@google.com>

David Gow <davidgow@google.com> writes:

> 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: bc145b370c ("Documentation: KUnit: Added KUnit Architecture")
> Signed-off-by: David Gow <davidgow@google.com>
> ---
>  Documentation/dev-tools/kunit/architecture.rst | 13 ++-----------
>  1 file changed, 2 insertions(+), 11 deletions(-)

Applied, thanks.

jon

      parent reply	other threads:[~2022-03-28 20:02 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-26  5:44 [PATCH] Documentation: kunit: Fix cross-referencing warnings David Gow
2022-03-28 16:51 ` Brendan Higgins
2022-03-28 20:02 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87r16l7slw.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=brendanhiggins@google.com \
    --cc=davidgow@google.com \
    --cc=dlatypov@google.com \
    --cc=elver@google.com \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).