Bug#34006439: Spell check issues in code comments

MRajcic · MRajcic · commit ffea0145505f · 2022-08-24T11:05:17.000+02:00
Post-push fix: Run clang-format on files reporting formatting issue

Approved by: Terje Rosten &lt;terje.rosten@oracle.com&gt;

Change-Id: I6ada0a23023947212f48bff44615bcfaae88909a
diff --git a/libchangestreams/include/mysql/cs/reader/binary/mysqlproto.h b/libchangestreams/include/mysql/cs/reader/binary/mysqlproto.h
@@ -107,8 +107,8 @@ class Mysql_protocol : public cs::reader::Reader {
    * If the state object is not provided, a new one will be created, which will
    * also be deleted when this object is destroyed.
    *
-   * @param state Optional parameter. If provided, it will be used as the initial
-   * state while attaching to the stream.
+   * @param state Optional parameter. If provided, it will be used as the
+   * initial state while attaching to the stream.
    *
    * @returns true if there is a failure, false otherwise.
    */
diff --git a/libchangestreams/include/mysql/cs/reader/state.h b/libchangestreams/include/mysql/cs/reader/state.h
@@ -43,8 +43,8 @@ class State {
   /**
    * @brief The set of gtids handled in this stream.
    *
-   * This set is updated every time a transaction identifier event comes down the
-   * stream. The identifier is added to the stream.
+   * This set is updated every time a transaction identifier event comes down
+   * the stream. The identifier is added to the stream.
    */
   binary_log::gtids::Gtid_set m_gtid_set;
 
diff --git a/mysys/lf_hash.cc b/mysys/lf_hash.cc
@@ -476,8 +476,9 @@ static uint cset_hash_sort_adapter(const LF_HASH *hash, const uchar *key,
   See wt_init() for example.
   As an alternative to using the above trick with decreasing
   LF_HASH::element_size, one can provide an "initialize" hook that will finish
-  initialization of an object provided by LF_ALLOCATOR and set the element key from
-  the object passed as parameter to lf_hash_insert instead of doing simple memcpy.
+  initialization of an object provided by LF_ALLOCATOR and set the element key
+  from the object passed as parameter to lf_hash_insert instead of doing simple
+  memcpy.
 */
 void lf_hash_init_impl(LF_HASH *hash, uint element_size, uint flags,
                        uint key_offset, uint key_length,
diff --git a/mysys/mf_iocache.cc b/mysys/mf_iocache.cc
@@ -35,11 +35,10 @@
   macros for read and writes for faster io.
   Used instead of FILE when reading or writing whole files.
   This code makes mf_rec_cache obsolete (currently only used by ISAM).
-  One can change info->pos_in_file to a higher value to skip bytes in the file if
-  also info->read_pos is set to info->read_end.
-  If called through open_cached_file(), then the temporary file will
-  only be created if a write exceeds the file buffer or if one calls
-  my_b_flush_io_cache().
+  One can change info->pos_in_file to a higher value to skip bytes in the file
+  if also info->read_pos is set to info->read_end. If called through
+  open_cached_file(), then the temporary file will only be created if a write
+  exceeds the file buffer or if one calls my_b_flush_io_cache().
 
   If one uses SEQ_READ_APPEND, then two buffers are allocated, one for
   reading and another for writing.  Reads are first done from disk and
diff --git a/mysys/my_string.cc b/mysys/my_string.cc
@@ -119,8 +119,8 @@ bool dynstr_trunc(DYNAMIC_STRING *str, size_t n) {
 
 /*
   Concatenates any number of strings, escapes any quote in the result, then
-  surrounds the resulting string in another set of quotes which is finally appended
-  to specified DYNAMIC_STRING.  This function is especially useful when
+  surrounds the resulting string in another set of quotes which is finally
+  appended to specified DYNAMIC_STRING.  This function is especially useful when
   building strings to be executed with the system() function.
 
   @param str Dynamic String which will have additional strings appended.
diff --git a/plugin/rewriter/rule.h b/plugin/rewriter/rule.h
@@ -67,8 +67,8 @@ class Pattern {
   std::vector<std::string> literals;
 
   /**
-    Loads the pattern. The pattern string is copied in deep-copy way. This is not done in
-    the CTOR because of the memory allocation.
+    Loads the pattern. The pattern string is copied in deep-copy way. This is
+    not done in the CTOR because of the memory allocation.
 
     This function does the following:
     - Parse the pattern string.
diff --git a/sql/gis/distance_sphere.cc b/sql/gis/distance_sphere.cc
@@ -47,8 +47,8 @@ namespace gis {
 /// Map Cartesian geometry to geographic, mapping degrees east = x, degrees
 /// north = y. Do not canonicalize coordinates of poles.
 ///
-/// Used when a SQL function needs to accept Cartesian coordinates as a shorthand
-/// for geographic with some default SRS.
+/// Used when a SQL function needs to accept Cartesian coordinates as a
+/// shorthand for geographic with some default SRS.
 static Geographic_point reinterpret_as_degrees(const Cartesian_point &g) {
   double lon_deg = g.x();
   double lat_deg = g.y();
@@ -65,8 +65,8 @@ static Geographic_point reinterpret_as_degrees(const Cartesian_point &g) {
 /// Map Cartesian geometry to geographic, mapping degrees east = x, degrees
 /// north = y. Do not canonicalize coordinates of poles.
 ///
-/// Used when a SQL function needs to accept Cartesian coordinates as a shorthand
-/// for geographic with some default SRS.
+/// Used when a SQL function needs to accept Cartesian coordinates as a
+/// shorthand for geographic with some default SRS.
 static Geographic_multipoint reinterpret_as_degrees(
     const Cartesian_multipoint &g) {
   Geographic_multipoint dg{};
diff --git a/sql/item_xmlfunc.cc b/sql/item_xmlfunc.cc
@@ -1169,7 +1169,7 @@ static MY_XPATH_FUNC *my_xpath_function(const char *beg, const char *end) {
   return nullptr;
 }
 
-/* Initialize a lex analyzer token */   
+/* Initialize a lex analyzer token */
 static void my_xpath_lex_init(MY_XPATH_LEX *lex, const char *str,
                               const char *strend) {
   lex->beg = str;
diff --git a/sql/join_optimizer/graph_simplification.h b/sql/join_optimizer/graph_simplification.h
@@ -99,7 +99,8 @@ class GraphSimplifier {
     APPLIED_SIMPLIFICATION,
 
     // We applied a simplification, but it was one that was forced upon us;
-    // we intended to apply the opposite, but discovered it would leave the graph
+    // we intended to apply the opposite, but discovered it would leave the
+    // graph
     // in an impossible state. Thus, the graph has been changed, but the actual
     // available join orderings are exactly as they were.
     APPLIED_NOOP,
diff --git a/sql/memory/unique_ptr.h b/sql/memory/unique_ptr.h
@@ -162,8 +162,8 @@ class Unique_ptr {
       std::enable_if_t<std::is_same<B, std::nullptr_t>::value> * = nullptr>
   Unique_ptr();
   /**
-    Class constructor, to be used with specific allocators, passing the allocator
-    object to be used.
+    Class constructor, to be used with specific allocators, passing the
+    allocator object to be used.
 
     @param alloc The allocator instance to be used.
    */
@@ -195,9 +195,9 @@ class Unique_ptr {
                              std::is_array<D>::value> * = nullptr>
   Unique_ptr(size_t size);
   /**
-    Class constructor, to be used with specific allocators and when `T` is not an
-    array type, passing the allocator object to be used and the parameters to be
-    used with `T` object constructor.
+    Class constructor, to be used with specific allocators and when `T` is not
+    an array type, passing the allocator object to be used and the parameters to
+    be used with `T` object constructor.
 
     @param alloc The allocator instance to be used.
     @param args The parameters to be used with `T` object constructor.
@@ -207,8 +207,9 @@ class Unique_ptr {
                              !std::is_array<D>::value> * = nullptr>
   Unique_ptr(A &alloc, Args &&... args);
   /**
-    Class constructor, to be used with no specific allocators and when `T` is not
-    an array type, passing the parameters to be used with `T` object constructor.
+    Class constructor, to be used with no specific allocators and when `T` is
+    not an array type, passing the parameters to be used with `T` object
+    constructor.
 
     @param args The parameters to be used with `T` object constructor.
    */
diff --git a/sql/message.h b/sql/message.h
@@ -1,80 +1,80 @@
-#ifndef MESSAGE_INCLUDED
-#define MESSAGE_INCLUDED
+#ifndef MESSAGE_INCLUDED
+#define MESSAGE_INCLUDED
 /* Copyright (c) 2008, 2022, Oracle and/or its affiliates.
-   Use is subject to license terms.
-
-   This program is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License, version 2.0,
-   as published by the Free Software Foundation.
-
-   This program is also distributed with certain software (including
-   but not limited to OpenSSL) that is licensed under separate terms,
-   as designated in a particular file or component or in included license
-   documentation.  The authors of MySQL hereby grant you an additional
-   permission to link the program and your derivative works with the
-   separately licensed software that they have included with MySQL.
-
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License, version 2.0, for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
-
-/*
-  To change or add messages mysqld writes to the Windows error log, run
-   mc.exe message.mc
-  and checkin generated messages.h, messages.rc and msg000001.bin under the
-  source control.
-  mc.exe can be installed with Windows SDK, some Visual Studio distributions
-  do not include it.
-*/
-
-//
+   Use is subject to license terms.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License, version 2.0,
+   as published by the Free Software Foundation.
+
+   This program is also distributed with certain software (including
+   but not limited to OpenSSL) that is licensed under separate terms,
+   as designated in a particular file or component or in included license
+   documentation.  The authors of MySQL hereby grant you an additional
+   permission to link the program and your derivative works with the
+   separately licensed software that they have included with MySQL.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License, version 2.0, for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
+
+/*
+  To change or add messages mysqld writes to the Windows error log, run
+   mc.exe message.mc
+  and checkin generated messages.h, messages.rc and msg000001.bin under the
+  source control.
+  mc.exe can be installed with Windows SDK, some Visual Studio distributions
+  do not include it.
+*/
+
+//
 //  Values are 32 bit values laid out as follows:
-//
-//   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
-//   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
-//  +---+-+-+-----------------------+-------------------------------+
-//  |Sev|C|R|     Facility          |               Code            |
-//  +---+-+-+-----------------------+-------------------------------+
-//
-//  where
-//
-//      Sev - is the severity code
-//
-//          00 - Success
-//          01 - Informational
-//          10 - Warning
-//          11 - Error
-//
-//      C - is the Customer code flag
-//
-//      R - is a reserved bit
-//
-//      Facility - is the facility code
-//
-//      Code - is the facility's status code
-//
-//
-// Define the facility codes
-//
-
-//
-// Define the severity codes
-//
-
-//
-// MessageId: MSG_DEFAULT
-//
-// MessageText:
-//
-//  %1For more information, see Help and Support Center at http://www.mysql.com.
-//
-//
-//
-#define MSG_DEFAULT 0xC0000064L
-
-#endif /* MESSAGE_INCLUDED */
+//
+//   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
+//   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
+//  +---+-+-+-----------------------+-------------------------------+
+//  |Sev|C|R|     Facility          |               Code            |
+//  +---+-+-+-----------------------+-------------------------------+
+//
+//  where
+//
+//      Sev - is the severity code
+//
+//          00 - Success
+//          01 - Informational
+//          10 - Warning
+//          11 - Error
+//
+//      C - is the Customer code flag
+//
+//      R - is a reserved bit
+//
+//      Facility - is the facility code
+//
+//      Code - is the facility's status code
+//
+//
+// Define the facility codes
+//
+
+//
+// Define the severity codes
+//
+
+//
+// MessageId: MSG_DEFAULT
+//
+// MessageText:
+//
+//  %1For more information, see Help and Support Center at http://www.mysql.com.
+//
+//
+//
+#define MSG_DEFAULT 0xC0000064L
+
+#endif /* MESSAGE_INCLUDED */
diff --git a/sql/rpl_mi.h b/sql/rpl_mi.h
@@ -799,7 +799,8 @@ class Master_info : public Rpl_info {
 
   /**
     Is the replica working in GTID only mode, meaning it does not
-    persist position related information when executing or queueing transactions.
+    persist position related information when executing or queueing
+    transactions.
   */
   bool m_gtid_only_mode;
 
diff --git a/sql/rpl_rli.h b/sql/rpl_rli.h
@@ -1138,9 +1138,9 @@ class Relay_log_info : public Rpl_info {
   /*
     This flag is turned ON when the workers array is initialized.
     Before destroying the workers array we check this flag to make sure
-    we are not destroying an uninitialized array. For the purpose of reporting the
-    worker status in performance schema table, we need to preserve the workers
-    array after worker thread was killed. So, we copy this array into
+    we are not destroying an uninitialized array. For the purpose of reporting
+    the worker status in performance schema table, we need to preserve the
+    workers array after worker thread was killed. So, we copy this array into
     workers_copy_pfs array which is used for reporting until next
     init_workers().
   */
diff --git a/sql/rpl_rli_pdb.h b/sql/rpl_rli_pdb.h
@@ -912,9 +912,8 @@ class Slave_worker : public Relay_log_info {
       MY_ATTRIBUTE((format(printf, 4, 0)));
 
  private:
-  ulong gaq_index;  // GAQ index of the current assignment
-  ulonglong
-      master_log_pos;  // event's cached log_pos for possible error report
+  ulong gaq_index;           // GAQ index of the current assignment
+  ulonglong master_log_pos;  // event's cached log_pos for possible error report
   void end_info();
   bool read_info(Rpl_info_handler *from) override;
   bool write_info(Rpl_info_handler *to) override;
diff --git a/sql/sys_vars_resource_mgr.h b/sql/sys_vars_resource_mgr.h
@@ -40,18 +40,20 @@
   (1) init :
         Creates a copy (memdup()) of global Sys_var_charptr system variable for
         the respective session variable (passed as a  parameter) & inserts it
-        into sysvar_string_alloc_hash (containing the allocated address) to infer
-        that memory has been allocated for the session. init() is called during
-        the initialization of session system variables. (plugin_thdvar_init())
+        into sysvar_string_alloc_hash (containing the allocated address) to
+        infer that memory has been allocated for the session. init() is called
+        during the initialization of session system variables.
+        (plugin_thdvar_init())
   (2) update :
         When the session variable is updated, the old memory is freed and new
         memory is allocated to hold the new value. The corresponding member in
-        sysvar_string_alloc_hash is also updated to hold the new allocated memory
-        address. (Sys_var_charptr::session_update())
+        sysvar_string_alloc_hash is also updated to hold the new allocated
+        memory address.
+        (Sys_var_charptr::session_update())
   (3) deinit :
         Its a one-shot operation to free all the session Sys_var_charptr system
-        variables. It basically traverses down the sysvar_string_alloc_hash
-        hash and calls free() for all the addresses that it holds.
+        variables. It basically traverses down the sysvar_string_alloc_hash hash
+        and calls free() for all the addresses that it holds.
 
   Note, there should always be at most one node per Sys_var_charptr session
   system variable.

Original file line number	Diff line number	Diff line change
`@@ -107,8 +107,8 @@ class Mysql_protocol : public cs::reader::Reader {`
`107`	`107`	`* If the state object is not provided, a new one will be created, which will`
`108`	`108`	`* also be deleted when this object is destroyed.`
`109`	`109`	`*`
`110`		`- * @param state Optional parameter. If provided, it will be used as the initial`
`111`		`- * state while attaching to the stream.`
	`110`	`+ * @param state Optional parameter. If provided, it will be used as the`
	`111`	`+ * initial state while attaching to the stream.`
`112`	`112`	`*`
`113`	`113`	`* @returns true if there is a failure, false otherwise.`
`114`	`114`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1169,7 +1169,7 @@ static MY_XPATH_FUNC my_xpath_function(const char beg, const char *end) {`
`1169`	`1169`	`return nullptr;`
`1170`	`1170`	`}`
`1171`	`1171`
`1172`		`-/* Initialize a lex analyzer token */`
	`1172`	`+/* Initialize a lex analyzer token */`
`1173`	`1173`	`static void my_xpath_lex_init(MY_XPATH_LEX lex, const char str,`
`1174`	`1174`	`const char *strend) {`
`1175`	`1175`	`lex->beg = str;`