All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	Brendan Higgins <brendanhiggins@google.com>,
	kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org,
	linux-kselftest@vger.kernel.org
Subject: [PATCH 08/12] kunit: test.h: fix a kernel-doc markup
Date: Sat,  2 Jul 2022 12:07:40 +0100	[thread overview]
Message-ID: <32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1656759988.git.mchehab@kernel.org>

Fix this kernel-doc warning:

	Documentation/dev-tools/kunit/api/test:9: ./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.

Functions should use func_name() on kernel-doc markups, as
documented at:
	Documentation/doc-guide/kernel-doc.rst

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/

 include/kunit/test.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 8ffcd7de9607..f1c1a95df9b8 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -320,7 +320,7 @@ static inline int kunit_run_all_tests(void)
  *
  * @__suites: a statically allocated list of &struct kunit_suite.
  *
- * This functions identically as &kunit_test_suites() except that it suppresses
+ * This functions identically as kunit_test_suites() except that it suppresses
  * modpost warnings for referencing functions marked __init or data marked
  * __initdata; this is OK because currently KUnit only runs tests upon boot
  * during the init phase or upon loading a module during the init phase.
-- 
2.36.1


  parent reply	other threads:[~2022-07-02 11:08 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-02 11:07 [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Mauro Carvalho Chehab
2022-07-02 11:07 ` [dm-devel] " Mauro Carvalho Chehab
2022-07-02 11:07 ` Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 01/12] docs: ext4: blockmap.rst: fix a broken table Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice Mauro Carvalho Chehab
2022-07-06 20:48   ` Dipen Patel
2022-07-06 21:40     ` Thierry Reding
2022-07-07 18:54       ` Jonathan Corbet
2022-07-02 11:07 ` [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst Mauro Carvalho Chehab
2022-07-02 11:07   ` [dm-devel] " Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 04/12] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork Mauro Carvalho Chehab
2022-07-12 19:57   ` Bjorn Helgaas
2022-07-02 11:07 ` [PATCH 05/12] docs: PCI: pci-vntb-howto.rst: fix a title markup Mauro Carvalho Chehab
2022-07-12 19:58   ` Bjorn Helgaas
2022-07-02 11:07 ` [PATCH 06/12] docs: virt: kvm: fix a title markup at api.rst Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 07/12] docs: ABI: sysfs-bus-nvdimm Mauro Carvalho Chehab
2022-07-07  5:31   ` kajoljain
2022-07-02 11:07 ` Mauro Carvalho Chehab [this message]
2022-07-02 13:18   ` [PATCH 08/12] kunit: test.h: fix a kernel-doc markup David Gow
2022-07-08 17:30     ` Shuah Khan
2022-07-02 11:07 ` [PATCH 09/12] net: mac80211: " Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file Mauro Carvalho Chehab
2022-07-02 11:07   ` Mauro Carvalho Chehab
2022-07-04 12:54   ` Takashi Iwai
2022-07-04 12:54     ` Takashi Iwai
2022-07-09  9:56     ` Mauro Carvalho Chehab
2022-07-09  9:56       ` Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow Mauro Carvalho Chehab
2022-07-06 16:34   ` Doug Anderson
2022-07-06 22:29     ` Doug Anderson
2022-07-08 22:19   ` (subset) " Bjorn Andersson
2022-07-02 11:07 ` [PATCH 12/12] docs: leds: index.rst: add leds-qcom-lpg to it Mauro Carvalho Chehab
2022-07-03  3:26 ` [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Bagas Sanjaya
2022-07-03  3:26   ` [dm-devel] " Bagas Sanjaya
2022-07-03  3:26   ` Bagas Sanjaya

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=32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=brendanhiggins@google.com \
    --cc=corbet@lwn.net \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=mchehab+huawei@kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.