minor editorial fixes (#1398)

* add text treatment for the _sat modifier

* fix image type typo

* add image types to OpenCL C syntax highlighting

* fix bad read image and write image channel data type lists

* remove extraneous space

* fix ND-range capitalization

* fix bad formatting for image addressing and filtering

* add one more image type to OpenCL C syntax highlighting

Author: bashbaug

OpenCL_C.txt

@@ -1805,7 +1805,7 @@ When converting from a floating-point type to integer type, the behavior is
 implementation-defined.
 
 Conversions to integer type may opt to convert using the optional saturated
-mode by appending the _sat modifier to the conversion function name.
+mode by appending the `_sat` modifier to the conversion function name.
 When in saturated mode, values that are outside the representable range
 shall clamp to the nearest representable value in the destination format.
 (NaN should be converted to 0).
@@ -11604,19 +11604,19 @@ uint4 read_imageui(
       *read_imagei* can only be used with image objects created with
       _image_channel_data_type_ set to one of the following values:
 
-        * {CL_SIGNED_INT8},
-        * {CL_SIGNED_INT16}, and
-        * {CL_SIGNED_INT32}.
+      {CL_SIGNED_INT8}, +
+      {CL_SIGNED_INT16} and +
+      {CL_SIGNED_INT32}.
 
       If the _image_channel_data_type_ is not one of the above values, the
       values returned by *read_imagei* are undefined.
 
       *read_imageui* can only be used with image objects created with
       _image_channel_data_type_ set to one of the following values:
 
-        * {CL_UNSIGNED_INT8},
-        * {CL_UNSIGNED_INT16}, and
-        * {CL_UNSIGNED_INT32}.
+      {CL_UNSIGNED_INT8}, +
+      {CL_UNSIGNED_INT16} and +
+      {CL_UNSIGNED_INT32}.
 
       If the _image_channel_data_type_ is not one of the above values, the
       values returned by *read_imageui* are undefined.
@@ -11675,19 +11675,19 @@ uint4 read_imageui(
       *read_imagei* can only be used with image objects created with
       _image_channel_data_type_ set to one of the following values:
 
-        * {CL_SIGNED_INT8},
-        * {CL_SIGNED_INT16}, and
-        * {CL_SIGNED_INT32}.
+      {CL_SIGNED_INT8}, +
+      {CL_SIGNED_INT16} and +
+      {CL_SIGNED_INT32}.
 
       If the _image_channel_data_type_ is not one of the above values, the
       values returned by *read_imagei* are undefined.
 
       *read_imageui* can only be used with image objects created with
       _image_channel_data_type_ set to one of the following values:
 
-        * {CL_UNSIGNED_INT8},
-        * {CL_UNSIGNED_INT16}, and
-        * {CL_UNSIGNED_INT32}.
+      {CL_UNSIGNED_INT8}, +
+      {CL_UNSIGNED_INT16} and +
+      {CL_UNSIGNED_INT32}.
 
       If the _image_channel_data_type_ is not one of the above values, the
       values returned by *read_imageui* are undefined.
@@ -11719,11 +11719,12 @@ float read_imagef(
       <<unified-spec, Requires>> support for the
       {cl_khr_gl_msaa_sharing_EXT} extension macro.
 a|
-[source,c]
+[source,opencl_c]
 ----
-float read_imagef(image2d_array_msaaa_depth_t image,
-                  int4 coord,
-                  int sample)
+float read_imagef(
+  image2d_array_msaa_depth_t image,
+  int4 coord,
+  int sample)
 ----
     | Use _coord.xy_ and _sample_ to do an element lookup in the 2D image
       identified by _coord.z_ in the 2D depth image array specified by
@@ -12162,14 +12163,14 @@ ifdef::cl_khr_fp16[and *write_imageh*]
       _image_channel_data_type_ set to one of the following values:
 
       {CL_SIGNED_INT8}, +
-      {CL_SIGNED_INT16}, or +
+      {CL_SIGNED_INT16} and +
       {CL_SIGNED_INT32}.
 
       *write_imageui* can only be used with image objects created with
       _image_channel_data_type_ set to one of the following values:
 
       {CL_UNSIGNED_INT8}, +
-      {CL_UNSIGNED_INT16}, or +
+      {CL_UNSIGNED_INT16} and +
       {CL_UNSIGNED_INT32}.
 
       The behavior of *write_imagef*,
@@ -16653,8 +16654,8 @@ footnote:[{fn-min-float-constants}].
 Let w~t~, h~t~ and d~t~ be the width, height (or image array size for a 1D
 image array) and depth (or image array size for a 2D image array) of the
 image in pixels.
-Let _coord.xy_ (also referred to as (_s_,_t_)) or _coord.xyz_ (also referred
-to as (_s_,_t_,_r_)) be the coordinates specified to *read_image{f|i|ui}*.
+Let _coord.xy_ (also referred to as (_s_, _t_)) or _coord.xyz_ (also referred
+to as (_s_, _t_, _r_)) be the coordinates specified to *read_image{f|i|ui}*.
 The sampler specified in *read_image{f|i|ui}* is used to determine how to
 sample the image and return an appropriate color.
 
@@ -16671,7 +16672,7 @@ For image arrays, the image array coordinate (i.e. _t_ if it is a 1D image
 array or _r_ if it is a 2D image array) specified to *read_image{f|i|ui}*
 must always be the un-normalized image coordinate value.
 
-Let (_u_,_v_,_w_) represent the unnormalized image coordinate values.
+Let (_u_, _v_, _w_) represent the unnormalized image coordinate values.
 
 
 [[addressing-and-filter-modes]]
@@ -16682,19 +16683,19 @@ generate the appropriate sample locations to read from the image if the
 addressing mode is not `CLK_ADDRESS_REPEAT` nor
 `CLK_ADDRESS_MIRRORED_REPEAT`.
 
-After generating the image coordinate (_u_,_v_,_w_) we apply the appropriate
+After generating the image coordinate (_u_, _v_, _w_) we apply the appropriate
 addressing and filter mode to generate the appropriate sample locations to
 read from the image.
 
-If values in (_u_,_v_,_w_) are `INF` or NaN, the behavior of
+If values in (_u_, _v_, _w_) are `INF` or NaN, the behavior of
 *read_image{f|i|ui}* is undefined.
 
 *Filter Mode* `CLK_FILTER_NEAREST`
 
 When filter mode is `CLK_FILTER_NEAREST`, the image element in the image
-that is nearest (in Manhattan distance) to that specified by (_u_,_v_,_w_)
+that is nearest (in Manhattan distance) to that specified by (_u_, _v_, _w_)
 is obtained.
-This means the image element at location (_i_,_j_,_k_) becomes the image
+This means the image element at location (_i_, _j_, _k_) becomes the image
 element value, where
 
 [source,opencl_c]
@@ -16704,9 +16705,9 @@ j = address_mode((int)floor(v))
 k = address_mode((int)floor(w))
 ----------
 
-For a 3D image, the image element at location (_i_,_j_,_k_) becomes the
+For a 3D image, the image element at location (_i_, _j_, _k_) becomes the
 color value.
-For a 2D image, the image element at location (_i_,_j_) becomes the color
+For a 2D image, the image element at location (_i_, _j_) becomes the color
 value.
 
 The following table describes the address_mode function.
@@ -16731,7 +16732,7 @@ The `clamp` function used in this table is defined as:
 clamp(a, b, c) = return (a < b) ? b : ((a > c) ? c : a)
 ----------
 
-If the selected texel location (_i_,_j_,_k_) refers to a location outside
+If the selected texel location (_i_, _j_, _k_) refers to a location outside
 the image, the border color is used as the color value for this texel.
 
 *Filter Mode* `CLK_FILTER_LINEAR`
@@ -16773,7 +16774,7 @@ T = (1 - a) * (1 - b) * (1 - c) * T_i0j0k0
     + a * b * c * T_i1j1k1
 ----------
 
-where `T_ijk` is the image element at location (_i_,_j_,_k_) in the 3D image.
+where `T_ijk` is the image element at location (_i_, _j_, _k_) in the 3D image.
 
 For a 2D image, the image element value is found as
 
@@ -16785,7 +16786,7 @@ T = (1 - a) * (1 - b) * T_i0j0
     + a * b * T_i1j1
 ----------
 
-where `T_ij` is the image element at location (_i_,_j_) in the 2D image.
+where `T_ij` is the image element at location (_i_, _j_) in the 2D image.
 
 If any of the selected `T_ijk` or `T_ij` in the above equations refers to a
 location outside the image, the border color is used as the color value for
@@ -16799,13 +16800,13 @@ We now discuss how the addressing and filter modes are applied to generate
 the appropriate sample locations to read from the image if the addressing
 mode is `CLK_ADDRESS_REPEAT`.
 
-If values in (_s_,_t_,_r_) are `INF` or NaN, the behavior of the built-in
+If values in (_s_, _t_, _r_) are `INF` or NaN, the behavior of the built-in
 image read functions is undefined.
 
 *Filter Mode* `CLK_FILTER_NEAREST`
 
 When filter mode is `CLK_FILTER_NEAREST`, the image element at location
-(_i_,_j_,_k_) becomes the image element value, with _i_, _j_, and _k_
+(_i_, _j_, _k_) becomes the image element value, with _i_, _j_, and _k_
 computed as
 
 [source,opencl_c]
@@ -16827,9 +16828,9 @@ if (k > d_t - 1)
 ----------
 
 
-For a 3D image, the image element at location (_i_,_j_,_k_) becomes the
+For a 3D image, the image element at location (_i_, _j_, _k_) becomes the
 color value.
-For a 2D image, the image element at location (_i_,_j_) becomes the color
+For a 2D image, the image element at location (_i_, _j_) becomes the color
 value.
 
 *Filter Mode* `CLK_FILTER_LINEAR`
@@ -16889,7 +16890,7 @@ T = (1 - a) * (1 - b) * (1 - c) * T_i0j0k0
     + a * b * c * T_i1j1k1
 ----------
 
-where `T_ijk` is the image element at location (_i_,_j_,_k_) in the 3D image.
+where `T_ijk` is the image element at location (_i_, _j_, _k_) in the 3D image.
 
 For a 2D image, the image element value is found as
 
@@ -16901,7 +16902,7 @@ T = (1 - a) * (1 - b) * T_i0j0
     + a * b * T_i1j1
 ----------
 
-where `T_ij` is the image element at location (_i_,_j_) in the 2D image.
+where `T_ij` is the image element at location (_i_, _j_) in the 2D image.
 
 If the image channel type is {CL_FLOAT} or {CL_HALF_FLOAT} and any of the
 image elements `T_ijk` or `T_ij` is `INF` or NaN, the behavior of the built-in
@@ -16913,41 +16914,41 @@ mode is `CLK_ADDRESS_MIRRORED_REPEAT`.
 The `CLK_ADDRESS_MIRRORED_REPEAT` addressing mode causes the image to be
 read as if it is tiled at every integer seam with the interpretation of the
 image data flipped at each integer crossing.
-For example, the (_s_,_t_,_r_) coordinates between 2 and 3 are addressed
+For example, the (_s_, _t_, _r_) coordinates between 2 and 3 are addressed
 into the image as coordinates from 1 down to 0.
-If values in (_s_,_t_,_r_) are `INF` or NaN, the behavior of the built-in
+If values in (_s_, _t_, _r_) are `INF` or NaN, the behavior of the built-in
 image read functions is undefined.
 
 *Filter Mode* `CLK_FILTER_NEAREST`
 
 When filter mode is `CLK_FILTER_NEAREST`, the image element at location
-(_i_,_j_,_k_) becomes the image element value, with _i_,_j_ and k computed
+(_i_, _j_, _k_) becomes the image element value, with _i_, _j_ and k computed
 as
 
 [source,opencl_c]
 ----------
-s' = 2.0f * rint(0.5f * s)
-s' = fabs(s - s')
-u = s' * w_t
+s_prime = 2.0f * rint(0.5f * s)
+s_prime = fabs(s - s_prime)
+u = s_prime * w_t
 i = (int)floor(u)
 i = min(i, w_t - 1)
 
-t' = 2.0f * rint(0.5f * t)
-t' = fabs(t - t')
-v = t' * h_t
+t_prime = 2.0f * rint(0.5f * t)
+t_prime = fabs(t - t_prime)
+v = t_prime * h_t
 j = (int)floor(v)
 j = min(j, h_t - 1)
 
-r' = 2.0f * rint(0.5f * r)
-r' = fabs(r - r')
-w = r' * d_t
+r_prime = 2.0f * rint(0.5f * r)
+r_prime = fabs(r - r_prime)
+w = r_prime * d_t
 k = (int)floor(w)
 k = min(k, d_t - 1)
 ----------
 
-For a 3D image, the image element at location (_i_,_j_,_k_) becomes the
+For a 3D image, the image element at location (_i_, _j_, _k_) becomes the
 color value.
-For a 2D image, the image element at location (_i_,_j_) becomes the color
+For a 2D image, the image element at location (_i_, _j_) becomes the color
 value.
 
 *Filter Mode* `CLK_FILTER_LINEAR`
@@ -16961,25 +16962,25 @@ Let
 
 [source,opencl_c]
 ----------
-s' = 2.0f * rint(0.5f * s)
-s' = fabs(s - s')
-u = s' * w_t
+s_prime = 2.0f * rint(0.5f * s)
+s_prime = fabs(s - s_prime)
+u = s_prime * w_t
 i0 = (int)floor(u - 0.5f)
 i1 = i0 + 1
 i0 = max(i0, 0)
 i1 = min(i1, w_t - 1)
 
-t' = 2.0f * rint(0.5f * t)
-t' = fabs(t - t')
-v = t' * h_t
+t_prime = 2.0f * rint(0.5f * t)
+t_prime = fabs(t - t_prime)
+v = t_prime * h_t
 j0 = (int)floor(v - 0.5f)
 j1 = j0 + 1
 j0 = max(j0, 0)
 j1 = min(j1, h_t - 1)
 
-r' = 2.0f * rint(0.5f * r)
-r' = fabs(r - r')
-w = r' * d_t
+r_prime = 2.0f * rint(0.5f * r)
+r_prime = fabs(r - r_prime)
+w = r_prime * d_t
 k0 = (int)floor(w - 0.5f)
 k1 = k0 + 1
 k0 = max(k0, 0)
@@ -17007,7 +17008,7 @@ T = (1 - a) * (1 - b) * (1 - c) * T_i0j0k0
     + a * b * c * T_i1j1k1
 ----------
 
-where `T_ijk` is the image element at location (_i_,_j_,_k_) in the 3D image.
+where `T_ijk` is the image element at location (_i_, _j_, _k_) in the 3D image.
 
 For a 2D image, the image element value is found as
 
@@ -17019,7 +17020,7 @@ T = (1 - a) * (1 - b) * T_i0j0
     + a * b * T_i1j1
 ----------
 
-where `T_ij` is the image element at location (_i_,_j_) in the 2D image.
+where `T_ij` is the image element at location (_i_, _j_) in the 2D image.
 
 For a 1D image, the image element value is found as
 
@@ -17042,7 +17043,7 @@ If the sampler is specified as using unnormalized coordinates
 `CLK_FILTER_NEAREST` and addressing mode set to one of the following modes -
 `CLK_ADDRESS_NONE`, `CLK_ADDRESS_CLAMP_TO_EDGE` or `CLK_ADDRESS_CLAMP`, the
 <<addressing-and-filter-modes,location of the image element in the image>>
-given by (_i_,_j_,_k_) will be computed without any loss of precision.
+given by (_i_, _j_, _k_) will be computed without any loss of precision.
 
 For all other sampler combinations of normalized or unnormalized
 coordinates, filter and addressing modes, the relative error or precision of
@@ -17752,7 +17753,7 @@ implementation produces and being checked for conformance.
 [[selecting-an-image-from-an-image-array]]
 == Selecting an Image From an Image Array
 
-Let (_u_,_v_,_w_) represent the unnormalized image coordinate values for
+Let (_u_, _v_, _w_) represent the unnormalized image coordinate values for
 reading from and/or writing to a 2D image in a 2D image array.
 
 When read using a sampler, the 2D image layer selected is computed as:
@@ -17768,7 +17769,7 @@ otherwise the layer selected is computed as:
 (since _w_ is already an integer) and the result is undefined if _w_ is not
 one of the integers 0, 1, ... d~t~ - 1.
 
-Let (_u_,_v_) represent the unnormalized image coordinate values for reading
+Let (_u_, _v_) represent the unnormalized image coordinate values for reading
 from and/or writing to a 1D image in a 1D image array.
 
 When read using a sampler, the 1D image layer selected is computed as:

api/opencl_architecture.asciidoc

@@ -301,7 +301,7 @@ within a work-group.
 The details of this mapping are described in the following section.
 
 
-=== Mapping Work-items Onto an Nd-range
+=== Mapping Work-items Onto an ND-range
 
 The index space supported by OpenCL is called an ND-range.
 An ND-range is an N-dimensional index space, where N is one, two or three.

api/opencl_platform_layer.asciidoc

@@ -1072,7 +1072,7 @@ include::{generated}/api/version-notes/CL_DEVICE_LOCAL_MEM_TYPE.asciidoc[]
   | {cl_device_local_mem_type_TYPE}
       | Type of local memory supported.
         This can be set to {CL_LOCAL_anchor} implying dedicated local memory storage
-        such as SRAM , or {CL_GLOBAL_anchor}.
+        such as SRAM, or {CL_GLOBAL_anchor}.
 
         For custom devices, {CL_NONE} can also be returned indicating no local
         memory support.

c/footnotes.asciidoc

@@ -276,9 +276,9 @@ Except for 3-component vectors whose size is defined as 4 times the size of each
 ]
 
 :fn-vec3-vload-vstore: pass:n[ \
-*vload3* and *vload_half3* read (_x_,_y_,_z_) components from address `(_p_ + (_offset_ * 3))` into a 3-component vector. \
-*vstore3* and *vstore_half3* write (_x_,_y_,_z_) components from a 3-component vector to address `(_p_ + (_offset_ * 3))`. \
-In addition, *vloada_half3* reads (_x_,_y_,_z_) components from address `(_p_ + (_offset_ * 4))` into a 3-component vector and *vstorea_half3* writes (_x_,_y_,_z_) components from a 3-component vector to address `(_p_ {plus} (_offset_ * 4))`. \
+*vload3* and *vload_half3* read (_x_, _y_, _z_) components from address `(_p_ + (_offset_ * 3))` into a 3-component vector. \
+*vstore3* and *vstore_half3* write (_x_, _y_, _z_) components from a 3-component vector to address `(_p_ + (_offset_ * 3))`. \
+In addition, *vloada_half3* reads (_x_, _y_, _z_) components from address `(_p_ + (_offset_ * 4))` into a 3-component vector and *vstorea_half3* writes (_x_, _y_, _z_) components from a 3-component vector to address `(_p_ {plus} (_offset_ * 4))`. \
 Whether *vloada_half3* and *vstorea_half3* read/write padding data between the third vector element and the next alignment boundary is implementation-defined. \
 The *vloada_* and *vstorea_* variants are provided to access data that is aligned to the size of the vector, and are intended to enable performance on hardware that can take advantage of the increased alignment. \
 ]