From 7f28de1e9494755d8b14a491f99d14aeb51e82ec Mon Sep 17 00:00:00 2001 From: Heiko Thiery Date: Tue, 10 Dec 2024 13:34:00 +0100 Subject: [PATCH] codespell: fix typo warnings Signed-off-by: Heiko Thiery --- docs/source/bmcWatchdog_cmd.rst | 2 +- docs/source/ipmDevGlobal_cmd.rst | 2 +- docs/source/ipmiMsgSupport_cmd.rst | 8 ++++---- docs/source/quick_start.rst | 6 +++--- pyipmi/bmc.py | 2 +- pyipmi/errors.py | 2 +- pyipmi/fields.py | 2 +- pyipmi/helper.py | 2 +- pyipmi/hpm.py | 2 +- pyipmi/interfaces/ipmb.py | 4 ++-- pyipmi/interfaces/rmcp.py | 2 +- pyipmi/ipmitool.py | 2 +- pyipmi/msgs/message.py | 4 ++-- 13 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/source/bmcWatchdog_cmd.rst b/docs/source/bmcWatchdog_cmd.rst index 461c7397..f20f450a 100644 --- a/docs/source/bmcWatchdog_cmd.rst +++ b/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 ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/ipmDevGlobal_cmd.rst b/docs/source/ipmDevGlobal_cmd.rst index 8817fba7..32c0aa6d 100644 --- a/docs/source/ipmDevGlobal_cmd.rst +++ b/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()** | diff --git a/docs/source/ipmiMsgSupport_cmd.rst b/docs/source/ipmiMsgSupport_cmd.rst index 188d595e..e6d86825 100644 --- a/docs/source/ipmiMsgSupport_cmd.rst +++ b/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)** | diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst index 800605da..dac7000f 100644 --- a/docs/source/quick_start.rst +++ b/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/ diff --git a/pyipmi/bmc.py b/pyipmi/bmc.py index f9619556..b5a05412 100644 --- a/pyipmi/bmc.py +++ b/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', ''), diff --git a/pyipmi/errors.py b/pyipmi/errors.py index 23b349d9..828a17d0 100644 --- a/pyipmi/errors.py +++ b/pyipmi/errors.py @@ -69,7 +69,7 @@ class DescriptionError(Exception): class RetryError(Exception): - """Maxium number of retries exceeded.""" + """Maximum number of retries exceeded.""" pass diff --git a/pyipmi/fields.py b/pyipmi/fields.py index 8de650ff..ec7380ff 100644 --- a/pyipmi/fields.py +++ b/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 diff --git a/pyipmi/helper.py b/pyipmi/helper.py index 0b634ccb..83bc7873 100644 --- a/pyipmi/helper.py +++ b/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 diff --git a/pyipmi/hpm.py b/pyipmi/hpm.py index a642ecc6..aa026a39 100644 --- a/pyipmi/hpm.py +++ b/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 diff --git a/pyipmi/interfaces/ipmb.py b/pyipmi/interfaces/ipmb.py index 911aaced..f2541603 100644 --- a/pyipmi/interfaces/ipmb.py +++ b/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 diff --git a/pyipmi/interfaces/rmcp.py b/pyipmi/interfaces/rmcp.py index a6e08ccb..b745f6d4 100644 --- a/pyipmi/interfaces/rmcp.py +++ b/pyipmi/interfaces/rmcp.py @@ -248,7 +248,7 @@ def _pack_sequence_number(self): return struct.unpack("I", seq))[0] def _padd_password(self): - """Padd the password. + """Pad the password. The password/key is 0 padded to 16-bytes for all specified authentication types. diff --git a/pyipmi/ipmitool.py b/pyipmi/ipmitool.py index 7f5fdb09..9d459695 100755 --- a/pyipmi/ipmitool.py +++ b/pyipmi/ipmitool.py @@ -474,7 +474,7 @@ def usage(toplevel=False): -I Set interface (available: rmcp, aardvark, ipmitool, ipmbdev) -H Set RMCP host -U Set RMCP user - -L Set RMCP priviledge level + -L Set RMCP privilege level -P Set RMCP password -o Set interface specific options (name=value, separated by commas, see below for available options). diff --git a/pyipmi/msgs/message.py b/pyipmi/msgs/message.py index 1aeb680b..0f3db356 100644 --- a/pyipmi/msgs/message.py +++ b/pyipmi/msgs/message.py @@ -54,7 +54,7 @@ def _length(self, obj): def encode(self, obj, data): a = getattr(obj, self.name) if len(a) != self._length(obj): - raise EncodingError('Array must be exaclty %d bytes long ' + raise EncodingError('Array must be exactly %d bytes long ' '(but is %d long)' % (self._length(obj), len(a))) for i in range(self._length(obj)): @@ -320,7 +320,7 @@ def __init__(self, *args, **kwargs): buf -- option message buffer to decode - Optional keyword arguments corresponts to members to set (matching + Optional keyword arguments corresponds to members to set (matching fields in self.__fields__, or 'data'). """ # create message fields