Merge pull request #686 from lukaszstolarczuk/fix-spellings

Fix random spelling issues

Author: pbalcer

REQUIREMENTS.md

@@ -28,9 +28,9 @@
 
 ### Library Language Binding Requirements
 * DPC++ Language binding requirements
-  + Performance Libraries that execute on multiple Intel IP’s shall support the DPCP++ language binding as the primary mechanism for programing on multiple Intel Hardware IP’s
+  + Performance Libraries that execute on multiple Intel IP’s shall support the DPCP++ language binding as the primary mechanism for programming on multiple Intel Hardware IP’s
   + If the library supports DPC++ for a only a subset of functions for offload to an accelerator (e.g. ATS), all CPU functions should all support DPC++ Language bindings so that application developers can write their entire application in DPC++
-  + If a Library only supports only the CPU, but is likey to be used with another library the supports DPC++ on CPU and ATS, the library shall also support DPC++ 
+  + If a Library only supports only the CPU, but is likely to be used with another library the supports DPC++ on CPU and ATS, the library shall also support DPC++ 
 * Libraries may support other language bindings (C/C++/FORTRAN/JAVA/PYTHON, etc.) to support existing user base and use cases required by the developer domain
 
 ### Library API Deprecation Management

ci/pyenv.cmd

@@ -112,7 +112,7 @@ goto :eof
 ::===============================================================
 :: Deletes existing python virtual env.
 :reset_python
-echo Reseting python...
+echo Resetting python...
 set VDIR_ACTIVE=
 if exist "%VDIR%" (
     call "%VDIR%\Scripts\deactivate.bat"

include/ur.py

@@ -476,7 +476,7 @@ class ur_device_info_v(IntEnum):
     MAX_READ_WRITE_IMAGE_ARGS = 32                  ## [uint32_t] max number of image objects arguments of a kernel declared
                                                     ## with the read_write qualifier
     IMAGE2D_MAX_WIDTH = 33                          ## [size_t] max width of Image2D object
-    IMAGE2D_MAX_HEIGHT = 34                         ## [size_t] max heigh of Image2D object
+    IMAGE2D_MAX_HEIGHT = 34                         ## [size_t] max height of Image2D object
     IMAGE3D_MAX_WIDTH = 35                          ## [size_t] max width of Image3D object
     IMAGE3D_MAX_HEIGHT = 36                         ## [size_t] max height of Image3D object
     IMAGE3D_MAX_DEPTH = 37                          ## [size_t] max depth of Image3D object
@@ -680,7 +680,7 @@ class ur_device_partition_value_t(Structure):
 class ur_device_partition_property_t(Structure):
     _fields_ = [
         ("type", ur_device_partition_t),                                ## [in] The partitioning type to be used.
-        ("value", ur_device_partition_value_t)                          ## [in] The paritioning value.
+        ("value", ur_device_partition_value_t)                          ## [in] The partitioning value.
     ]
 
 ###############################################################################

include/ur_api.h

@@ -863,7 +863,7 @@ typedef enum ur_device_info_t {
     UR_DEVICE_INFO_MAX_READ_WRITE_IMAGE_ARGS = 32,                ///< [uint32_t] max number of image objects arguments of a kernel declared
                                                                   ///< with the read_write qualifier
     UR_DEVICE_INFO_IMAGE2D_MAX_WIDTH = 33,                        ///< [size_t] max width of Image2D object
-    UR_DEVICE_INFO_IMAGE2D_MAX_HEIGHT = 34,                       ///< [size_t] max heigh of Image2D object
+    UR_DEVICE_INFO_IMAGE2D_MAX_HEIGHT = 34,                       ///< [size_t] max height of Image2D object
     UR_DEVICE_INFO_IMAGE3D_MAX_WIDTH = 35,                        ///< [size_t] max width of Image3D object
     UR_DEVICE_INFO_IMAGE3D_MAX_HEIGHT = 36,                       ///< [size_t] max height of Image3D object
     UR_DEVICE_INFO_IMAGE3D_MAX_DEPTH = 37,                        ///< [size_t] max depth of Image3D object
@@ -1173,7 +1173,7 @@ typedef union ur_device_partition_value_t {
 /// @brief Device partition property
 typedef struct ur_device_partition_property_t {
     ur_device_partition_t type;        ///< [in] The partitioning type to be used.
-    ur_device_partition_value_t value; ///< [in] The paritioning value.
+    ur_device_partition_value_t value; ///< [in] The partitioning value.
 
 } ur_device_partition_property_t;
 

scripts/YaML.md

@@ -20,7 +20,7 @@ This document describes the YaML format used by the scripts for the API specific
 * A header requires the following scalar fields: {`desc`}
   - `desc` will be used as the region description comment
 * A header may take the following optional scalar fields: {`ordinal`, `version`}
-  - `ordinal` will be used to override the default order (alphebetical) in which regions appear in the specification; `default="1000"`. Multiple regions with the same ordinal will be ordered alphebetically.
+  - `ordinal` will be used to override the default order (alphabetical) in which regions appear in the specification; `default="1000"`. Multiple regions with the same ordinal will be ordered alphabetically.
   - `version` can be used to define the minimum API version for all documents in the yml file; `default="1.0"`
 
 <table>
@@ -325,7 +325,7 @@ class ur_name_handle_t(c_void_p):
   - `version` will be used to define the minimum API version in which the enum will appear; `default="1.0"` This will also affect the order in which the enum appears within its section and class.
   - `extend` will be used to extend an existing enum with additional `etors`, 
   usually used to implement experimental features. `type` *must* refer to an 
-  exiting enum and each `etor` must include a unique `value`.
+  existing enum and each `etor` must include a unique `value`.
   - `typed_etors` boolean value that will be used to determine whether the enum's values have associated types.
 * An enum requires the following sequence of mappings: {`etors`}
   - An etor requires the following scalar fields: {`name`, `desc`}

scripts/core/EXP-BINDLESS-IMAGES.rst

@@ -148,16 +148,16 @@ Functions
 Changelog
 --------------------------------------------------------------------------------
 
-+----------+---------------------------------------------------------+
-| Revision | Changes                                                 |
-+==========+=========================================================+
-| 1.0      | Initial Draft                                           |
-+----------+---------------------------------------------------------+
-| 2.0      || Added device parameters to UR functions.               |
-|          || Added sub-region copy paramters to image copy function.|
-|          || Removed 3D USM capabilities.                           |
-|          || Added mip filter mode.                                 |
-+----------+---------------------------------------------------------+
++----------+----------------------------------------------------------+
+| Revision | Changes                                                  |
++==========+==========================================================+
+| 1.0      | Initial Draft                                            |
++----------+----------------------------------------------------------+
+| 2.0      || Added device parameters to UR functions.                |
+|          || Added sub-region copy parameters to image copy function.|
+|          || Removed 3D USM capabilities.                            |
+|          || Added mip filter mode.                                  |
++----------+----------------------------------------------------------+
 
 Contributors
 --------------------------------------------------------------------------------

scripts/core/device.yml

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2022 Intel Corporation
+# Copyright (C) 2022-2023 Intel Corporation
 #
 # Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
 # See LICENSE.TXT
@@ -216,7 +216,7 @@ etors:
     - name: IMAGE2D_MAX_WIDTH
       desc: "[size_t] max width of Image2D object"
     - name: IMAGE2D_MAX_HEIGHT
-      desc: "[size_t] max heigh of Image2D object"
+      desc: "[size_t] max height of Image2D object"
     - name: IMAGE3D_MAX_WIDTH
       desc: "[size_t] max width of Image3D object"
     - name: IMAGE3D_MAX_HEIGHT
@@ -539,7 +539,7 @@ members:
       desc: "[in] The partitioning type to be used."
     - type: $x_device_partition_value_t
       name: value
-      desc: "[in] The paritioning value."
+      desc: "[in] The partitioning value."
 --- #--------------------------------------------------------------------------
 type: struct
 desc: "Device Partition Properties"

scripts/parse_specs.py

@@ -1,5 +1,5 @@
 """
- Copyright (C) 2022 Intel Corporation
+ Copyright (C) 2022-2023 Intel Corporation
 
  Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
  See LICENSE.TXT
@@ -231,7 +231,7 @@ def __validate_etors(d, tags):
                     raise Exception(prefix+"typed etor " + item['name'] + " must begin with a type identifier: [type]")
                 type_name = _subt(type, tags)
                 if not is_iso(type_name):
-                    raise Exception(prefix+"type " + str(type) + " in a typed etor " + item['name'] + " must be a valid ISO C identifer")
+                    raise Exception(prefix+"type " + str(type) + " in a typed etor " + item['name'] + " must be a valid ISO C identifier")
 
             __validate_name(item, 'name', tags, case='upper', prefix=prefix)
 

scripts/templates/exp_feat.rst.mako

@@ -76,7 +76,7 @@ Support
 Adapters which support this experimental feature *must* return the valid string 
 defined in ``${"${X}"}_${"_".join(name.split("-")).upper()}_EXTENSION_STRING_EXP`` 
 as one of the options from ${"${x}"}DeviceGetInfo when querying for 
-${"${X}"}_DEVICE_INFO_EXTENSIONS. Conversly, before using any of the 
+${"${X}"}_DEVICE_INFO_EXTENSIONS. Conversely, before using any of the 
 functionality defined in this experimental feature the user *must* use the 
 device query to determine if the adapter supports this feature.
 

scripts/templates/helper.py

@@ -1,5 +1,5 @@
 """
- Copyright (C) 2022 Intel Corporation
+ Copyright (C) 2022-2023 Intel Corporation
 
  Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
  See LICENSE.TXT
@@ -427,7 +427,7 @@ def is_global(item, tags):
 
 """
 Public:
-    substitues each tag['key'] with tag['value']
+    substitutes each tag['key'] with tag['value']
     if comment, then insert doxygen '::' notation at beginning (for autogen links)
 """
 def subt(namespace, tags, string, comment=False, remove_namespace=False):

source/common/umf_pools/disjoint_pool.cpp

@@ -113,7 +113,7 @@ class Slab {
     // Hints where to start search for free chunk in a slab
     size_t FirstFreeChunkIdx = 0;
 
-    // Return the index of the first available chunk, SIZE_MAX otherwize
+    // Return the index of the first available chunk, SIZE_MAX otherwise
     size_t FindFirstAvailableChunkIdx() const;
 
     // Register/Unregister the slab in the global slab address map.

source/common/unified_malloc_framework/include/umf/memory_pool_ops.h

@@ -26,7 +26,7 @@ struct umf_memory_pool_ops_t {
     uint32_t version;
 
     ///
-    /// \brief Intializes memory pool.
+    /// \brief Initializes memory pool.
     /// \param providers array of memory providers that will be used for coarse-grain allocations.
     ///        Should contain at least one memory provider.
     /// \param numProvider number of elements in the providers array

source/common/unified_malloc_framework/include/umf/memory_provider.h

@@ -123,7 +123,7 @@ umfMemoryProviderPurgeLazy(umf_memory_provider_handle_t hProvider, void *ptr,
 
 ///
 /// \brief Discard physical pages within the virtual memory mapping associated at given addr and size.
-///        This call is synchronous and if it suceeds, pages are guaranteed to be zero-filled on the next access.
+///        This call is synchronous and if it succeeds, pages are guaranteed to be zero-filled on the next access.
 /// \param hProvider handle to the memory provider
 /// \param ptr beginning of the virtual memory range
 /// \param size size of the virtual memory range
@@ -135,7 +135,7 @@ umfMemoryProviderPurgeForce(umf_memory_provider_handle_t hProvider, void *ptr,
                             size_t size);
 
 ///
-/// \brief Retrive name of a given memory provider.
+/// \brief Retrieve name of a given memory provider.
 /// \param hProvider handle to the memory provider
 /// \param ppName [out] pointer to a string containing name of the provider
 const char *umfMemoryProviderGetName(umf_memory_provider_handle_t hProvider);

source/common/unified_malloc_framework/include/umf/memory_provider_ops.h

@@ -26,7 +26,7 @@ struct umf_memory_provider_ops_t {
     uint32_t version;
 
     ///
-    /// \brief Intializes memory pool.
+    /// \brief Initializes memory pool.
     /// \param params pool-specific params
     /// \param pool returns pointer to the pool
     /// \return UMF_RESULT_SUCCESS on success or appropriate error code on failure.

source/common/unified_malloc_framework/src/memory_tracker.h

@@ -26,7 +26,7 @@ void *umfMemoryTrackerGetPool(umf_memory_tracker_handle_t hTracker,
                               const void *ptr);
 
 // Creates a memory provider that tracks each allocation/deallocation through umf_memory_tracker_handle_t and
-// forwards all requests to hUpstream memory Provider. hUpstream liftime should be managed by the user of this function.
+// forwards all requests to hUpstream memory Provider. hUpstream lifetime should be managed by the user of this function.
 enum umf_result_t umfTrackingMemoryProviderCreate(
     umf_memory_provider_handle_t hUpstream, umf_memory_pool_handle_t hPool,
     umf_memory_provider_handle_t *hTrackingProvider);

test/unified_malloc_framework/memoryPoolAPI.cpp

@@ -286,15 +286,15 @@ TEST_F(test, getLastFailedMemoryProvider) {
                   umfMemoryProviderGetName(umfGetLastFailedMemoryProvider())),
               "provider2");
 
-    // succesfull provider should not be returned by umfGetLastFailedMemoryProvider
+    // successful provider should not be returned by umfGetLastFailedMemoryProvider
     allocResult = UMF_RESULT_SUCCESS;
     ptr = umfPoolMalloc(pool.get(), allocSize);
     ASSERT_NE(ptr, nullptr);
     ASSERT_EQ(std::string_view(
                   umfMemoryProviderGetName(umfGetLastFailedMemoryProvider())),
               "provider2");
 
-    // erorr in another thread should not impact umfGetLastFailedMemoryProvider on this thread
+    // error in another thread should not impact umfGetLastFailedMemoryProvider on this thread
     allocResult = UMF_RESULT_ERROR_UNKNOWN;
     std::thread t([&, hPool = pool.get()] {
         ptr = umfPoolMalloc(hPool, allocSize);

tools/urtrace/collector.cpp

@@ -181,7 +181,7 @@ static class cli_args {
     bool no_args;
     enum output_format output_format;
     std::optional<std::string>
-        filter_str; //the filter_str is kept primarly for printing.
+        filter_str; //the filter_str is kept primarily for printing.
     std::optional<std::regex> filter;
 } cli_args;