codespell: fix typo warnings

Signed-off-by: Heiko Thiery <[email protected]>

Author: hthiery

docs/source/bmcWatchdog_cmd.rst

@@ -49,7 +49,7 @@ For example:
 
    ipmi.set_watchdog_timer(watchdog_timer)
 
-where the ``watchdog_timer`` has the attributes shown bellow for the next command.
+where the ``watchdog_timer`` has the attributes shown below for the next command.
 
 Get Watchdog Timer Command
 ~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/ipmDevGlobal_cmd.rst

@@ -102,7 +102,7 @@ For example:
 Cold Reset Command
 ~~~~~~~~~~~~~~~~~~
 
-This command directs the **Target** to perform a 'Cold Reset' of itself. The device reinitalizes its event, communcation, and sensor funtioncs. Self Test, if implemented, will be also run.
+This command directs the **Target** to perform a 'Cold Reset' of itself. The device reinitalizes its event, communication, and sensor funtioncs. Self Test, if implemented, will be also run.
 
 +------------------------------+
 | **cold_reset()**             |

docs/source/ipmiMsgSupport_cmd.rst

@@ -84,13 +84,13 @@ This is not equivalent with a single IPMI command, but represents a high level A
 | **establish()**              |
 +------------------------------+
 
-creates and activates a session of the ``ipmi.session`` instance with the given authentication and privilige level. Multiple IPMI commands are used to establish the session. The following steps are done during the session establishment for an RMCP interface:
+creates and activates a session of the ``ipmi.session`` instance with the given authentication and privilege level. Multiple IPMI commands are used to establish the session. The following steps are done during the session establishment for an RMCP interface:
 
   - ping the **Target** IP address
   - issue a **"Get Channel Authentication Capabilities"** command
   - issue a **"Get Session Challenge"** command
   - issue an **"Activate Session"** command
-  - issue a **"Set Session Privilege Level"** command (privilige is set always to ADMINISTRATOR level)
+  - issue a **"Set Session Privilege Level"** command (privilege is set always to ADMINISTRATOR level)
 
 If ``keep_alive_interval`` argument for the interface instantiation was set to a nonzero value then the channel is kept alive by regularly sending the **"Get Device ID"** IPMI command.
 
@@ -109,7 +109,7 @@ This command is used to retrieve capability information about a particular chann
 | **get_channel_authentication_capabilities(channel, priv_lvl)**  |
 +-----------------------------------------------------------------+
 
-You should pass the channel number to ``channel``, and the requested maximum privilige level to ``priv_lvl``.
+You should pass the channel number to ``channel``, and the requested maximum privilege level to ``priv_lvl``.
 
 Example:
 
@@ -121,7 +121,7 @@ Example:
 Master Write-Read Command
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This command can be used for low level |I2C|/SMBus write, read, or write-read accesses to the IPMB or private busses behind a management controller. The command can also be used for providing low-level access to devices that provide an SMBus slave interface.
+This command can be used for low level |I2C|/SMBus write, read, or write-read accesses to the IPMB or private buses behind a management controller. The command can also be used for providing low-level access to devices that provide an SMBus slave interface.
 
 +---------------------------------------------------------------------------+
 | **i2c_write_read(bus_type, bus_id, channel, address, count, data=None)**  |

docs/source/quick_start.rst

@@ -23,7 +23,7 @@ Before establishing the session the interface type shall be defined. There are 4
   * **'aardvark'** - :abbr:`IPMB (Intelligent Platform Management Bus)` interface (using the `Total Phase`_ Aardvark)
   * **'mock'** - This interface uses the ipmitool raw command to "emulate" an :abbr:`RMCP (Remote Management Control Protocol)` session. It uses the session information to assemble the correct ipmitool parameters. Therefore, a session must be established before any request can be sent.
 
-Then you create an instance of the ``pyipmi.Ipmi`` object using the ``interface`` instance just created, and set also the required parameteres of the interface type. You should also set the :abbr:`IPMI (Intelligent Platform Management Interface)` **Target**, otherwise different runtime errors shall be expected later on when invoking methods of this library. Finally, you can try to establish a session. If there is a connection problem (no response), then you get the following error during session establishment: 
+Then you create an instance of the ``pyipmi.Ipmi`` object using the ``interface`` instance just created, and set also the required parameters of the interface type. You should also set the :abbr:`IPMI (Intelligent Platform Management Interface)` **Target**, otherwise different runtime errors shall be expected later on when invoking methods of this library. Finally, you can try to establish a session. If there is a connection problem (no response), then you get the following error during session establishment: 
 
 .. error::
 
@@ -261,7 +261,7 @@ ipmitool command:
 IPMB with Aardvark
 ******************
 
-For :abbr:`IPMB (Intelligent Platform Management Bus)` interface with Aardvark tool you should use the followig code:
+For :abbr:`IPMB (Intelligent Platform Management Bus)` interface with Aardvark tool you should use the following code:
 
 .. code:: python
 
@@ -345,7 +345,7 @@ in which case debug, info and warning messages are all recorded in the **'ipmi_d
 
 .. note::
 
-  It is assumed in all code examples that the instantiation of the ``pyipmi.Ipmi`` object is called **ipmi**, thus **ipmi** will preceed all the methods and attributes of the ``pyipmi.Ipmi`` object.
+  It is assumed in all code examples that the instantiation of the ``pyipmi.Ipmi`` object is called **ipmi**, thus **ipmi** will proceed all the methods and attributes of the ``pyipmi.Ipmi`` object.
 
 .. _Total Phase: http://www.totalphase.com
 .. _ipmitool: http://sourceforge.net/projects/ipmitool/

pyipmi/bmc.py

@@ -89,7 +89,7 @@ class Watchdog(State):
     TIMEOUT_ACTION_POWER_CYCLE = 3
 
     __properties__ = [
-        # (propery, description)
+        # (property, description)
         ('timer_use', ''),
         ('dont_stop', ''),
         ('is_running', ''),

pyipmi/errors.py

@@ -69,7 +69,7 @@ class DescriptionError(Exception):
 
 
 class RetryError(Exception):
-    """Maxium number of retries exceeded."""
+    """Maximum number of retries exceeded."""
     pass
 
 

pyipmi/fields.py

@@ -64,7 +64,7 @@ def _unpack6bitascii(data):
 
 class TypeLengthString(object):
     """
-    This is the TYPE/LENGTH BYTE FORMAT field represenation according the
+    This is the TYPE/LENGTH BYTE FORMAT field representation according the
     Platform Management FRU Information Storage Definition v1.0.
 
     In addition the difference to the 'FRU Information Storage Definition' to

pyipmi/helper.py

@@ -85,7 +85,7 @@ def get_sdr_data_helper(reserve_fn, get_fn, record_id, reservation_id=None):
             (next_id, data) = get_fn(reservation_id, record_id, offset, length)
         except CompletionCodeError as e:
             if e.cc == constants.CC_CANT_RET_NUM_REQ_BYTES:
-                # reduce max lenght
+                # reduce max length
                 max_req_len -= 4
                 if max_req_len <= 0:
                     retry = 0

pyipmi/hpm.py

@@ -314,7 +314,7 @@ def preparation_stage(self, image):
         # tbd check version
 
         ####################################################
-        # compare current revision with upgrade image earlist comp rev
+        # compare current revision with upgrade image earliest comp rev
         targetCap = self.get_target_upgrade_capabilities()
         # tbd check version
 

pyipmi/interfaces/ipmb.py

@@ -149,7 +149,7 @@ def encode_ipmb_msg(header, data):
 
 
 def encode_send_message(payload, rq_sa, rs_sa, channel, seq, tracking=1):
-    """Encode a send message command and embedd the message to be send.
+    """Encode a send message command and embed the message to be send.
 
     payload: the message to be send as bytestring
     rq_sa: the requester source address
@@ -178,7 +178,7 @@ def encode_send_message(payload, rq_sa, rs_sa, channel, seq, tracking=1):
 
 
 def encode_bridged_message(routing, header, payload, seq):
-    """Encode a (multi-)bridged command and embedd the message to be send.
+    """Encode a (multi-)bridged command and embed the message to be send.
 
     routing:
     payload: the message to be send as bytestring