Skip to content

Commit fe7f56a

Browse files
bagasmejnikula
authored andcommitted
drm/i915/doc: Escape wildcard in method names
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: 0c3064c ("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> Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com> Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com> Link: https://patchwork.freedesktop.org/patch/msgid/20230203100215.31852-2-bagasdotme@gmail.com (cherry picked from commit ec852e3) Signed-off-by: Jani Nikula <jani.nikula@intel.com>
1 parent 48075a6 commit fe7f56a

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

drivers/gpu/drm/i915/gt/intel_workarounds.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* creation to have a "primed golden context", i.e. a context image that
3131
* already contains the changes needed to all the registers.
3232
*
33-
* Context workarounds should be implemented in the *_ctx_workarounds_init()
33+
* Context workarounds should be implemented in the \*_ctx_workarounds_init()
3434
* variants respective to the targeted platforms.
3535
*
3636
* - Engine workarounds: the list of these WAs is applied whenever the specific
@@ -55,7 +55,7 @@
5555
* - GT workarounds: the list of these WAs is applied whenever these registers
5656
* revert to their default values: on GPU reset, suspend/resume [1]_, etc.
5757
*
58-
* GT workarounds should be implemented in the *_gt_workarounds_init()
58+
* GT workarounds should be implemented in the \*_gt_workarounds_init()
5959
* variants respective to the targeted platforms.
6060
*
6161
* - Register whitelist: some workarounds need to be implemented in userspace,
@@ -64,7 +64,7 @@
6464
* this is just a special case of a MMIO workaround (as we write the list of
6565
* these to/be-whitelisted registers to some special HW registers).
6666
*
67-
* Register whitelisting should be done in the *_whitelist_build() variants
67+
* Register whitelisting should be done in the \*_whitelist_build() variants
6868
* respective to the targeted platforms.
6969
*
7070
* - Workaround batchbuffers: buffers that get executed automatically by the

0 commit comments

Comments
 (0)