Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm/xe: Fix case for asserts in documentation

The rendered html documentation for "Xe ASSERTs" doesn't look nice with
the mixed caps and gives the impression it was a typo. Use Title Case
Style.

Reviewed-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20241105071539.2623727-1-lucas.demarchi@intel.com
Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>

+6 -6
+4 -4
drivers/gpu/drm/xe/xe_assert.h
··· 14 14 #include "xe_step.h" 15 15 16 16 /** 17 - * DOC: Xe ASSERTs 17 + * DOC: Xe Asserts 18 18 * 19 19 * While Xe driver aims to be simpler than legacy i915 driver it is still 20 20 * complex enough that some changes introduced while adding new functionality ··· 103 103 * (&CONFIG_DRM_XE_DEBUG must be enabled) and cannot be used in expressions 104 104 * or as a condition. 105 105 * 106 - * See `Xe ASSERTs`_ for general usage guidelines. 106 + * See `Xe Asserts`_ for general usage guidelines. 107 107 */ 108 108 #define xe_assert(xe, condition) xe_assert_msg((xe), condition, "") 109 109 #define xe_assert_msg(xe, condition, msg, arg...) ({ \ ··· 138 138 * (&CONFIG_DRM_XE_DEBUG must be enabled) and cannot be used in expressions 139 139 * or as a condition. 140 140 * 141 - * See `Xe ASSERTs`_ for general usage guidelines. 141 + * See `Xe Asserts`_ for general usage guidelines. 142 142 */ 143 143 #define xe_tile_assert(tile, condition) xe_tile_assert_msg((tile), condition, "") 144 144 #define xe_tile_assert_msg(tile, condition, msg, arg...) ({ \ ··· 162 162 * (&CONFIG_DRM_XE_DEBUG must be enabled) and cannot be used in expressions 163 163 * or as a condition. 164 164 * 165 - * See `Xe ASSERTs`_ for general usage guidelines. 165 + * See `Xe Asserts`_ for general usage guidelines. 166 166 */ 167 167 #define xe_gt_assert(gt, condition) xe_gt_assert_msg((gt), condition, "") 168 168 #define xe_gt_assert_msg(gt, condition, msg, arg...) ({ \
+1 -1
drivers/gpu/drm/xe/xe_gt_sriov_pf_helpers.h
··· 18 18 * is within a range of supported VF numbers (up to maximum number of VFs that 19 19 * driver can support, including VF0 that represents the PF itself). 20 20 * 21 - * Note: Effective only on debug builds. See `Xe ASSERTs`_ for more information. 21 + * Note: Effective only on debug builds. See `Xe Asserts`_ for more information. 22 22 */ 23 23 #define xe_gt_sriov_pf_assert_vfid(gt, vfid) xe_sriov_pf_assert_vfid(gt_to_xe(gt), (vfid)) 24 24
+1 -1
drivers/gpu/drm/xe/xe_sriov_pf_helpers.h
··· 20 20 * is within a range of supported VF numbers (up to maximum number of VFs that 21 21 * driver can support, including VF0 that represents the PF itself). 22 22 * 23 - * Note: Effective only on debug builds. See `Xe ASSERTs`_ for more information. 23 + * Note: Effective only on debug builds. See `Xe Asserts`_ for more information. 24 24 */ 25 25 #define xe_sriov_pf_assert_vfid(xe, vfid) \ 26 26 xe_assert((xe), (vfid) <= xe_sriov_pf_get_totalvfs(xe))