Commit fe7f56a7 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Jani Nikula
Browse files

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: 0c3064cf ("drm/i915/doc: Document where to implement register workarounds")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Signed-off-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20230203100215.31852-2-bagasdotme@gmail.com


(cherry picked from commit ec852e3c)
Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
parent 48075a66

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

+3 −3
Original line number Diff line number Diff line
@@ -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