Skip to content

Commit 1d339ec

Browse files
committed
[NFC] Whitespace fixes in yml files
Trim trailing whitespace in the yml files. This also affected some source files because our generation system assumes a line ending with a space means to insert a line break on the word before (which I assume is a bug).
1 parent 2ccfc81 commit 1d339ec

26 files changed

+216
-293
lines changed

include/ur_api.h

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1298,10 +1298,8 @@ typedef enum ur_platform_backend_t {
12981298
#endif
12991299
///////////////////////////////////////////////////////////////////////////////
13001300
#ifndef UR_DEVICE_BINARY_TARGET_UNKNOWN
1301-
/// @brief Target identification strings for
1302-
/// ::ur_device_binary_t.pDeviceTargetSpec
1303-
/// A device type represented by a particular target triple requires
1304-
/// specific
1301+
/// @brief Target identification strings for ::ur_device_binary_t.pDeviceTargetSpec
1302+
/// A device type represented by a particular target triple requires specific
13051303
/// binary images. We need to map the image type onto the device target triple
13061304
#define UR_DEVICE_BINARY_TARGET_UNKNOWN "<unknown>"
13071305
#endif // UR_DEVICE_BINARY_TARGET_UNKNOWN
@@ -1824,8 +1822,7 @@ typedef enum ur_device_affinity_domain_flag_t {
18241822
///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA,
18251823
///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE,
18261824
///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE,
1827-
///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE,
1828-
///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE,
1825+
///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE,
18291826
///< and partition the device into sub devices comprised of compute units
18301827
///< that share memory subsystems at this level.
18311828
/// @cond
@@ -2610,8 +2607,7 @@ typedef struct ur_image_desc_t {
26102607
///
26112608
/// @details
26122609
/// - The primary ::ur_image_format_t that must be supported by all the
2613-
/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA,
2614-
/// UR_IMAGE_CHANNEL_TYPE_UNORM_INT8},
2610+
/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8},
26152611
/// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16},
26162612
/// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8},
26172613
/// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16},
@@ -6141,13 +6137,11 @@ urEnqueueKernelLaunch(
61416137
const size_t *pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that
61426138
///< specify the number of local work-items forming a work-group that will
61436139
///< execute the kernel function.
6144-
///< If nullptr, the runtime implementation will choose the work-group
6145-
///< size.
6140+
///< If nullptr, the runtime implementation will choose the work-group size.
61466141
uint32_t numEventsInWaitList, ///< [in] size of the event wait list
61476142
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
61486143
///< events that must be complete before the kernel execution.
6149-
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait
6150-
///< event.
6144+
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
61516145
ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
61526146
///< kernel execution instance.
61536147
);
@@ -7150,8 +7144,7 @@ urEnqueueUSMFill2D(
71507144
uint32_t numEventsInWaitList, ///< [in] size of the event wait list
71517145
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
71527146
///< events that must be complete before the kernel execution.
7153-
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait
7154-
///< event.
7147+
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
71557148
ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
71567149
///< kernel execution instance.
71577150
);
@@ -7201,8 +7194,7 @@ urEnqueueUSMMemcpy2D(
72017194
uint32_t numEventsInWaitList, ///< [in] size of the event wait list
72027195
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
72037196
///< events that must be complete before the kernel execution.
7204-
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait
7205-
///< event.
7197+
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
72067198
ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
72077199
///< kernel execution instance.
72087200
);
@@ -7240,8 +7232,7 @@ urEnqueueDeviceGlobalVariableWrite(
72407232
uint32_t numEventsInWaitList, ///< [in] size of the event wait list.
72417233
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
72427234
///< events that must be complete before the kernel execution.
7243-
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait
7244-
///< event.
7235+
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
72457236
ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
72467237
///< kernel execution instance.
72477238
);
@@ -7279,8 +7270,7 @@ urEnqueueDeviceGlobalVariableRead(
72797270
uint32_t numEventsInWaitList, ///< [in] size of the event wait list.
72807271
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
72817272
///< events that must be complete before the kernel execution.
7282-
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait
7283-
///< event.
7273+
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
72847274
ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
72857275
///< kernel execution instance.
72867276
);
@@ -7320,8 +7310,7 @@ urEnqueueReadHostPipe(
73207310
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
73217311
///< events that must be complete before the host pipe read.
73227312
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
7323-
ur_event_handle_t *phEvent ///< [out][optional] returns an event object that identifies this read
7324-
///< command
7313+
ur_event_handle_t *phEvent ///< [out][optional] returns an event object that identifies this read command
73257314
///< and can be used to query or queue a wait for this command to complete.
73267315
);
73277316

@@ -9117,13 +9106,11 @@ urEnqueueCooperativeKernelLaunchExp(
91179106
const size_t *pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that
91189107
///< specify the number of local work-items forming a work-group that will
91199108
///< execute the kernel function.
9120-
///< If nullptr, the runtime implementation will choose the work-group
9121-
///< size.
9109+
///< If nullptr, the runtime implementation will choose the work-group size.
91229110
uint32_t numEventsInWaitList, ///< [in] size of the event wait list
91239111
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
91249112
///< events that must be complete before the kernel execution.
9125-
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait
9126-
///< event.
9113+
///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
91279114
ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
91289115
///< kernel execution instance.
91299116
);
@@ -9182,8 +9169,7 @@ urEnqueueTimestampRecordingExp(
91829169
uint32_t numEventsInWaitList, ///< [in] size of the event wait list
91839170
const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
91849171
///< events that must be complete before the kernel execution.
9185-
///< If nullptr, the numEventsInWaitList must be 0, indicating no wait
9186-
///< events.
9172+
///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
91879173
ur_event_handle_t *phEvent ///< [in,out] return an event object that identifies this particular kernel
91889174
///< execution instance. Profiling information can be queried
91899175
///< from this event as if `hQueue` had profiling enabled. Querying

scripts/core/adapter.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ params:
2828
- type: "uint32_t"
2929
name: NumEntries
3030
desc: |
31-
[in] the number of adapters to be added to phAdapters.
31+
[in] the number of adapters to be added to phAdapters.
3232
If phAdapters is not NULL, then NumEntries should be greater than zero, otherwise $X_RESULT_ERROR_INVALID_SIZE,
3333
will be returned.
3434
- type: "$x_adapter_handle_t*"
@@ -39,7 +39,7 @@ params:
3939
- type: "uint32_t*"
4040
name: "pNumAdapters"
4141
desc: |
42-
[out][optional] returns the total number of adapters available.
42+
[out][optional] returns the total number of adapters available.
4343
returns:
4444
- $X_RESULT_ERROR_INVALID_SIZE:
4545
- "`NumEntries == 0 && phAdapters != NULL`"

scripts/core/context.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ etors:
9595
- name: REFERENCE_COUNT
9696
desc: |
9797
[uint32_t] Reference count of the context object.
98-
The reference count returned should be considered immediately stale.
98+
The reference count returned should be considered immediately stale.
9999
It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
100100
- name: USM_MEMCPY2D_SUPPORT
101101
desc: "[$x_bool_t] to indicate if the $xEnqueueUSMMemcpy2D entrypoint is supported."
@@ -107,11 +107,11 @@ etors:
107107
desc: "[$x_memory_scope_capability_flags_t] return a bit-field of atomic memory scope capabilities."
108108
- name: ATOMIC_FENCE_ORDER_CAPABILITIES
109109
desc: |
110-
[$x_memory_order_capability_flags_t] return a bit-field of atomic memory fence order capabilities.
110+
[$x_memory_order_capability_flags_t] return a bit-field of atomic memory fence order capabilities.
111111
Zero is returned if the backend does not support context-level fences.
112112
- name: ATOMIC_FENCE_SCOPE_CAPABILITIES
113113
desc: |
114-
[$x_memory_scope_capability_flags_t] return a bit-field of atomic memory fence scope capabilities.
114+
[$x_memory_scope_capability_flags_t] return a bit-field of atomic memory fence scope capabilities.
115115
Zero is returned if the backend does not support context-level fences.
116116
--- #--------------------------------------------------------------------------
117117
type: function
@@ -122,7 +122,7 @@ decl: static
122122
ordinal: "0"
123123
analogue:
124124
- "**clReleaseContext**"
125-
details:
125+
details:
126126
- "The application may call this function from simultaneous threads for the same context."
127127
- "The implementation of this function should be thread-safe."
128128
params:
@@ -157,7 +157,7 @@ params:
157157
name: pPropValue
158158
desc: |
159159
[out][optional][typename(propName, propSize)] array of bytes holding the info.
160-
if propSize is not equal to or greater than the real number of bytes needed to return
160+
if propSize is not equal to or greater than the real number of bytes needed to return
161161
the info then the $X_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
162162
- type: "size_t*"
163163
name: pPropSizeRet

scripts/core/device.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ ordinal: "2"
1515
--- #--------------------------------------------------------------------------
1616
type: macro
1717
desc: |
18-
Target identification strings for $x_device_binary_t.pDeviceTargetSpec
19-
A device type represented by a particular target triple requires specific
18+
Target identification strings for $x_device_binary_t.pDeviceTargetSpec
19+
A device type represented by a particular target triple requires specific
2020
binary images. We need to map the image type onto the device target triple
2121
name: "$X_DEVICE_BINARY_TARGET_UNKNOWN"
2222
value: "\"<unknown>\""
@@ -35,7 +35,7 @@ value: "\"spir64\""
3535
--- #--------------------------------------------------------------------------
3636
type: macro
3737
desc: |
38-
Device-specific binary images produced from SPIR-V 64-bit <-> various
38+
Device-specific binary images produced from SPIR-V 64-bit <-> various
3939
"spir64_*" triples for specific 64-bit OpenCL CPU devices
4040
name: "$X_DEVICE_BINARY_TARGET_SPIRV64_X86_64"
4141
value: "\"spir64_x86_64\""
@@ -75,7 +75,7 @@ members:
7575
name: pDeviceTargetSpec
7676
desc: |
7777
[in] null-terminated string representation of the device's target architecture.
78-
For example:
78+
For example:
7979
+ $X_DEVICE_BINARY_TARGET_UNKNOWN
8080
+ $X_DEVICE_BINARY_TARGET_SPIRV32
8181
+ $X_DEVICE_BINARY_TARGET_SPIRV64
@@ -326,7 +326,7 @@ etors:
326326
- name: REFERENCE_COUNT
327327
desc: |
328328
[uint32_t] Reference count of the device object.
329-
The reference count returned should be considered immediately stale.
329+
The reference count returned should be considered immediately stale.
330330
It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
331331
- name: IL_VERSION
332332
desc: "[char[]] IL version"
@@ -356,7 +356,7 @@ etors:
356356
desc: "[uint32_t] maximum number of sub-devices when the device is partitioned"
357357
- name: PARTITION_AFFINITY_DOMAIN
358358
desc: |
359-
[$x_device_affinity_domain_flags_t] Returns a bit-field of the supported affinity domains for partitioning.
359+
[$x_device_affinity_domain_flags_t] Returns a bit-field of the supported affinity domains for partitioning.
360360
If the device does not support any affinity domains, then 0 will be returned.
361361
- name: PARTITION_TYPE
362362
desc: "[$x_device_partition_property_t[]] return an array of $x_device_partition_property_t for properties specified in $xDevicePartition"
@@ -412,7 +412,7 @@ etors:
412412
desc: "[$x_bool_t] support for bfloat16"
413413
- name: MAX_COMPUTE_QUEUE_INDICES
414414
desc: |
415-
[uint32_t] Returns 1 if the device doesn't have a notion of a
415+
[uint32_t] Returns 1 if the device doesn't have a notion of a
416416
queue index. Otherwise, returns the number of queue indices that are
417417
available for this device.
418418
- name: KERNEL_SET_SPECIALIZATION_CONSTANTS
@@ -548,10 +548,10 @@ etors:
548548
value: "$X_BIT(4)"
549549
- name: NEXT_PARTITIONABLE
550550
desc: |
551-
Split the device along the next partitionable affinity domain.
551+
Split the device along the next partitionable affinity domain.
552552
The implementation shall find the first level along which the device
553-
or sub device may be further subdivided in the order:
554-
$X_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE,
553+
or sub device may be further subdivided in the order:
554+
$X_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE,
555555
and partition the device into sub devices comprised of compute units that share memory subsystems at this level.
556556
value: "$X_BIT(5)"
557557
--- #--------------------------------------------------------------------------
@@ -679,7 +679,7 @@ params:
679679
- type: "uint32_t"
680680
name: NumBinaries
681681
desc: |
682-
[in] the number of binaries passed in ppBinaries.
682+
[in] the number of binaries passed in ppBinaries.
683683
Must greater than or equal to zero otherwise $X_RESULT_ERROR_INVALID_VALUE is returned.
684684
- type: "uint32_t*"
685685
name: pSelectedBinary
@@ -850,13 +850,13 @@ params:
850850
desc: "[in] handle of the device instance"
851851
- type: "uint64_t*"
852852
name: pDeviceTimestamp
853-
desc: |
854-
[out][optional] pointer to the Device's global timestamp that
853+
desc: |
854+
[out][optional] pointer to the Device's global timestamp that
855855
correlates with the Host's global timestamp value
856856
- type: "uint64_t*"
857857
name: pHostTimestamp
858858
desc: |
859-
[out][optional] pointer to the Host's global timestamp that
859+
[out][optional] pointer to the Host's global timestamp that
860860
correlates with the Device's global timestamp value
861861
--- #--------------------------------------------------------------------------
862862
type: enum

0 commit comments

Comments
 (0)