Commit 71fb41bd authored by Lucas De Marchi's avatar Lucas De Marchi
Browse files

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: default avatarMichal Wajdeczko <michal.wajdeczko@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20241105071539.2623727-1-lucas.demarchi@intel.com


Signed-off-by: default avatarLucas De Marchi <lucas.demarchi@intel.com>
parent a8f6035a

drivers/gpu/drm/xe/xe_assert.h

+4 −4
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ 
#include "xe_step.h"



/**

 * DOC: Xe ASSERTs

 * DOC: Xe Asserts

 *

 * While Xe driver aims to be simpler than legacy i915 driver it is still

 * complex enough that some changes introduced while adding new functionality
@@ -103,7 +103,7 @@ 
 * (&CONFIG_DRM_XE_DEBUG must be enabled) and cannot be used in expressions

 * or as a condition.

 *

 * See `Xe ASSERTs`_ for general usage guidelines.

 * See `Xe Asserts`_ for general usage guidelines.

 */

#define xe_assert(xe, condition) xe_assert_msg((xe), condition, "")

#define xe_assert_msg(xe, condition, msg, arg...) ({						\
@@ -138,7 +138,7 @@ 
 * (&CONFIG_DRM_XE_DEBUG must be enabled) and cannot be used in expressions

 * or as a condition.

 *

 * See `Xe ASSERTs`_ for general usage guidelines.

 * See `Xe Asserts`_ for general usage guidelines.

 */

#define xe_tile_assert(tile, condition) xe_tile_assert_msg((tile), condition, "")

#define xe_tile_assert_msg(tile, condition, msg, arg...) ({					\
@@ -162,7 +162,7 @@ 
 * (&CONFIG_DRM_XE_DEBUG must be enabled) and cannot be used in expressions

 * or as a condition.

 *

 * See `Xe ASSERTs`_ for general usage guidelines.

 * See `Xe Asserts`_ for general usage guidelines.

 */

#define xe_gt_assert(gt, condition) xe_gt_assert_msg((gt), condition, "")

#define xe_gt_assert_msg(gt, condition, msg, arg...) ({						\

drivers/gpu/drm/xe/xe_gt_sriov_pf_helpers.h

+1 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ 
 * is within a range of supported VF numbers (up to maximum number of VFs that

 * driver can support, including VF0 that represents the PF itself).

 *

 * Note: Effective only on debug builds. See `Xe ASSERTs`_ for more information.

 * Note: Effective only on debug builds. See `Xe Asserts`_ for more information.

 */

#define xe_gt_sriov_pf_assert_vfid(gt, vfid)	xe_sriov_pf_assert_vfid(gt_to_xe(gt), (vfid))

drivers/gpu/drm/xe/xe_sriov_pf_helpers.h

+1 −1
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ 
 * is within a range of supported VF numbers (up to maximum number of VFs that

 * driver can support, including VF0 that represents the PF itself).

 *

 * Note: Effective only on debug builds. See `Xe ASSERTs`_ for more information.

 * Note: Effective only on debug builds. See `Xe Asserts`_ for more information.

 */

#define xe_sriov_pf_assert_vfid(xe, vfid) \

	xe_assert((xe), (vfid) <= xe_sriov_pf_get_totalvfs(xe))