From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Intel Graphics Development List <intel-gfx@lists.freedesktop.org>,
DRI Development List <dri-devel@lists.freedesktop.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Media Mailing List <linux-media@vger.kernel.org>,
Linux Next Mailing List <linux-next@vger.kernel.org>
Cc: "Jani Nikula" <jani.nikula@linux.intel.com>,
"Joonas Lahtinen" <joonas.lahtinen@linux.intel.com>,
"Rodrigo Vivi" <rodrigo.vivi@intel.com>,
"Tvrtko Ursulin" <tvrtko.ursulin@linux.intel.com>,
"David Airlie" <airlied@gmail.com>,
"Daniel Vetter" <daniel@ffwll.ch>,
"Luben Tuikov" <luben.tuikov@amd.com>,
"Mauro Carvalho Chehab" <mchehab@kernel.org>,
"Matt Roper" <matthew.d.roper@intel.com>,
"Gustavo Sousa" <gustavo.sousa@intel.com>,
"Balasubramani Vivekanandan"
<balasubramani.vivekanandan@intel.com>,
"Matt Atwood" <matthew.s.atwood@intel.com>,
"José Roberto de Souza" <jose.souza@intel.com>,
"Srinivasan Shanmugam" <srinivasan.s@intel.com>,
"Lucas De Marchi" <lucas.demarchi@intel.com>,
"Lucas Stach" <l.stach@pengutronix.de>,
"Andrey Grodzovsky" <andrey.grodzovsky@amd.com>,
"Sakari Ailus" <sakari.ailus@linux.intel.com>,
"Linus Walleij" <linus.walleij@linaro.org>,
"Hans de Goede" <hdegoede@redhat.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Stephen Rothwell" <sfr@canb.auug.org.au>
Subject: [PATCH 1/3] drm/i915/doc: Escape wildcard in method names
Date: Fri, 3 Feb 2023 17:02:13 +0700 [thread overview]
Message-ID: <20230203100215.31852-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20230203100215.31852-1-bagasdotme@gmail.com>
Stephen Rothwell reported htmldocs warnings:
Documentation/gpu/i915:64: drivers/gpu/drm/i915/gt/intel_workarounds.c:32: WARNING: Inline emphasis start-string without end-string.
Documentation/gpu/i915:64: drivers/gpu/drm/i915/gt/intel_workarounds.c:57: WARNING: Inline emphasis start-string without end-string.
Documentation/gpu/i915:64: drivers/gpu/drm/i915/gt/intel_workarounds.c:66: WARNING: Inline emphasis start-string without end-string.
Escape wildcards in *_ctx_workarounds_init(), *_gt_workarounds_init(), and
*_whitelist_build() to fix above warnings.
Link: https://lore.kernel.org/linux-next/20230203134622.0b6315b9@canb.auug.org.au/
Fixes: 0c3064cf33fbfa ("drm/i915/doc: Document where to implement register workarounds")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
drivers/gpu/drm/i915/gt/intel_workarounds.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/drivers/gpu/drm/i915/gt/intel_workarounds.c b/drivers/gpu/drm/i915/gt/intel_workarounds.c
index 3111df350f5722..a00ec692d980c0 100644
--- a/drivers/gpu/drm/i915/gt/intel_workarounds.c
+++ b/drivers/gpu/drm/i915/gt/intel_workarounds.c
@@ -30,7 +30,7 @@
* creation to have a "primed golden context", i.e. a context image that
* already contains the changes needed to all the registers.
*
- * Context workarounds should be implemented in the *_ctx_workarounds_init()
+ * Context workarounds should be implemented in the \*_ctx_workarounds_init()
* variants respective to the targeted platforms.
*
* - Engine workarounds: the list of these WAs is applied whenever the specific
@@ -55,7 +55,7 @@
* - GT workarounds: the list of these WAs is applied whenever these registers
* revert to their default values: on GPU reset, suspend/resume [1]_, etc.
*
- * GT workarounds should be implemented in the *_gt_workarounds_init()
+ * GT workarounds should be implemented in the \*_gt_workarounds_init()
* variants respective to the targeted platforms.
*
* - Register whitelist: some workarounds need to be implemented in userspace,
@@ -64,7 +64,7 @@
* this is just a special case of a MMIO workaround (as we write the list of
* these to/be-whitelisted registers to some special HW registers).
*
- * Register whitelisting should be done in the *_whitelist_build() variants
+ * Register whitelisting should be done in the \*_whitelist_build() variants
* respective to the targeted platforms.
*
* - Workaround batchbuffers: buffers that get executed automatically by the
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2023-02-03 10:02 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-03 10:02 [PATCH 0/3] htmldocs fixes for next-20230203 Bagas Sanjaya
2023-02-03 10:02 ` Bagas Sanjaya [this message]
2023-02-06 16:50 ` [PATCH 1/3] drm/i915/doc: Escape wildcard in method names Rodrigo Vivi
2023-02-03 10:02 ` [PATCH 2/3] drm/scheduler: Fix elapsed_ns kernel-doc error Bagas Sanjaya
2023-02-03 11:27 ` Lucas Stach
2023-02-04 1:56 ` Bagas Sanjaya
2023-02-03 10:02 ` [PATCH 3/3] media: v4l2-core: Describe privacy_led field of v4l2_subdev Bagas Sanjaya
2023-05-17 18:08 ` Sakari Ailus
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=20230203100215.31852-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=airlied@gmail.com \
--cc=andrey.grodzovsky@amd.com \
--cc=balasubramani.vivekanandan@intel.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=gustavo.sousa@intel.com \
--cc=hdegoede@redhat.com \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jani.nikula@linux.intel.com \
--cc=joonas.lahtinen@linux.intel.com \
--cc=jose.souza@intel.com \
--cc=l.stach@pengutronix.de \
--cc=linus.walleij@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=luben.tuikov@amd.com \
--cc=lucas.demarchi@intel.com \
--cc=matthew.d.roper@intel.com \
--cc=matthew.s.atwood@intel.com \
--cc=mchehab@kernel.org \
--cc=rodrigo.vivi@intel.com \
--cc=sakari.ailus@linux.intel.com \
--cc=sfr@canb.auug.org.au \
--cc=srinivasan.s@intel.com \
--cc=tvrtko.ursulin@linux.intel.com \
/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