Fix typos throughout the codebase

doc/dbus.rst

@@ -17,7 +17,7 @@ Changing settings on a device is a three-step process:
 
 #. Change the various properties to the desired value
 #. Invoke :func:`org.freedesktop.ratbag1.Device.Commit() <Commit>`
-#. Optional: if an error occured writing the new data to the device,
+#. Optional: if an error occurred writing the new data to the device,
    a :func:`org.freedesktop.ratbag1.Resync <Resync>` signal is emitted on the device and
    all properties are updated accordingly.
 
@@ -87,7 +87,7 @@ interact with ratbagd.
 
         The DBus API version. This is a stopgap feature while the DBus API
         is still in flux. The version has no backwards or
-        forward-compatibilty guarantees - your client must understand
+        forward-compatibility guarantees - your client must understand
         **exactly** the same version, it is not enough to support an older
         or a newer version.
 
@@ -323,7 +323,7 @@ org.freedesktop.ratbag1.Resolution
         True if this is the currently active resolution, false otherwise.
 
         Resolutions can only be set to active, but never to not
-        active - at least one resoultion must be active at all
+        active - at least one resolution must be active at all
         times. This property is read-only, use the
         :func:`SetActive` method to set a resolution as the
         active resolution.

meson.build

@@ -501,7 +501,7 @@ if meson.version().version_compare('>= 0.53.0')
 endif
 py_version = py3.language_version()
 
-# From python 3.8 we neeed python3-embed
+# From python 3.8 we need python3-embed
 embed = py_version.version_compare('>= 3.8') ? '-embed' : ''
 if not dep_python3.found()
   dep_python3 = dependency('python-@0@@1@'.format(py_version, embed), required : false)

src/driver-gskill.c

@@ -667,7 +667,7 @@ gskill_macro_code_from_event(struct ratbag_device *device,
 	uint8_t macro_code;
 
 	/*
-	 * The miscellanious keycodes are ORd with 0x70 to indicate press, 0xF0
+	 * The miscellaneous keycodes are ORd with 0x70 to indicate press, 0xF0
 	 * to indicate release
 	 */
 	if (event->type == RATBAG_MACRO_EVENT_KEY_PRESSED)
@@ -1452,7 +1452,7 @@ gskill_commit(struct ratbag_device *device)
 	 * G.Skill mice only have a concept of how many profiles are enabled,
 	 * not which ones are and aren't enabled. So in order to provide the
 	 * ability to disable individual profiles we need to only write the
-	 * enabled profiles and make sure no holes are left inbetween profiles
+	 * enabled profiles and make sure no holes are left in between profiles
 	 */
 	for (i = 0; i < GSKILL_PROFILE_MAX; i++) {
 		profile = ratbag_device_get_profile(device, i);

src/driver-hidpp20.c

@@ -55,7 +55,7 @@
 #define HIDPP_CAP_COLOR_LED_EFFECTS_8070		(1 << 5)
 #define HIDPP_CAP_ONBOARD_PROFILES_8100			(1 << 6)
 #define HIDPP_CAP_LED_SW_CONTROL_1300			(1 << 7)
-#define HIDPP_CAP_ADJUSTIBLE_REPORT_RATE_8060		(1 << 8)
+#define HIDPP_CAP_ADJUSTABLE_REPORT_RATE_8060		(1 << 8)
 #define HIDPP_CAP_BATTERY_VOLTAGE_1001			(1 << 9)
 #define HIDPP_CAP_RGB_EFFECTS_8071			(1 << 10)
 
@@ -963,7 +963,7 @@ hidpp20drv_read_resolution_dpi(struct ratbag_profile *profile)
 			ratbag_resolution_set_dpi_list(res, &default_dpi, 1);
 	}
 
-	if (drv_data->capabilities & HIDPP_CAP_ADJUSTIBLE_REPORT_RATE_8060) {
+	if (drv_data->capabilities & HIDPP_CAP_ADJUSTABLE_REPORT_RATE_8060) {
 		rc = hidpp20drv_read_report_rate_8060(device);
 		if (rc < 0 && drv_data->report_rates[0] == 0)
 			return rc;
@@ -1087,7 +1087,7 @@ hidpp20drv_update_report_rate(struct ratbag_profile *profile, int hz)
 	if (drv_data->capabilities & HIDPP_CAP_ONBOARD_PROFILES_8100)
 		return hidpp20drv_update_report_rate_8100(profile, hz);
 
-	if (drv_data->capabilities & HIDPP_CAP_ADJUSTIBLE_REPORT_RATE_8060) {
+	if (drv_data->capabilities & HIDPP_CAP_ADJUSTABLE_REPORT_RATE_8060) {
 		rc = hidpp20drv_update_report_rate_8060(profile, hz);
 
 		/* re-populate the profile with the correct value if we fail */
@@ -1456,11 +1456,11 @@ hidpp20drv_init_feature(struct ratbag_device *device, uint16_t feature)
 		if (rc < 0)
 			return 0; /* this is not a hard failure */
 
-		drv_data->capabilities |= HIDPP_CAP_ADJUSTIBLE_REPORT_RATE_8060;
+		drv_data->capabilities |= HIDPP_CAP_ADJUSTABLE_REPORT_RATE_8060;
 		break;
 	}
 	case HIDPP_PAGE_COLOR_LED_EFFECTS: {
-		/* The 8070 feauture implemented in the G602 doesn't follow the spec,
+		/* The 8070 feature implemented in the G602 doesn't follow the spec,
 		 * so we ignore it */
 		if (ratbag_device_data_hidpp20_get_quirk(device->data) == HIDPP20_QUIRK_G602)
 			break;

src/driver-logitech-g300.c

@@ -120,7 +120,7 @@ struct logitech_g300_button_mapping {
 };
 
 static struct logitech_g300_button_mapping logitech_g300_button_mapping[] = {
-	/* 0x00 is either key or unassigned. Must be handled separatly  */
+	/* 0x00 is either key or unassigned. Must be handled separately  */
 	{ 0x01, BUTTON_ACTION_BUTTON(1) },
 	{ 0x02, BUTTON_ACTION_BUTTON(2) },
 	{ 0x03, BUTTON_ACTION_BUTTON(3) },

src/driver-logitech-g600.c

@@ -129,7 +129,7 @@ static const struct logitech_g600_button_type_mapping logitech_g600_button_type_
 	{ 23, RATBAG_BUTTON_TYPE_MIDDLE }, // G-shift + middle
 	{ 24, RATBAG_BUTTON_TYPE_WHEEL_LEFT},  // G-shift + scroll left
 	{ 25, RATBAG_BUTTON_TYPE_WHEEL_RIGHT}, // G-shift + scroll right
-	{ 26, RATBAG_BUTTON_TYPE_PINKIE }, // G-shift + Pinky(shift modifer)
+	{ 26, RATBAG_BUTTON_TYPE_PINKIE }, // G-shift + Pinky(shift modifier)
 	{ 27, RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UP }, // G-shift + 07
 	{ 28, RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UP }, // G-shift + G08
 	{ 29, RATBAG_BUTTON_TYPE_SIDE }, // G-shift + G09

src/driver-roccat-kone-emp.c

@@ -238,7 +238,7 @@ static struct roccat_button_mapping roccat_button_mapping[] = {
 	{ 20, BUTTON_ACTION_SPECIAL(RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UP) },
 	{ 21, BUTTON_ACTION_SPECIAL(RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UP) },
 	{ 22, BUTTON_ACTION_SPECIAL(RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWN) },
-/* FIXME:   { 23, Toogle sensibility }, */
+/* FIXME:   { 23, Toggle sensibility }, */
 /* FIXME:   { 24, Sensibility UP }, */
 /* FIXME:   { 25, Sensibility Down }, */
 /* FIXME:   { 27, open driver/swarm },  -> hidraw report 02 83 01 00 00 00 00 00 */
@@ -520,7 +520,7 @@ roccat_set_current_profile(struct ratbag_device *device, unsigned int index)
  * Sets the profile and which information we want to get from the mouse
  *
  * @param profile is the index of the profile from which you want the info. But, it is also used as a memory bank
- * identifier when quering a macro. In this case, the first bank can be queried by adding 0x10 to the profile index,
+ * identifier when querying a macro. In this case, the first bank can be queried by adding 0x10 to the profile index,
  * and the second bank, by adding 0x20.
  * @param type can be either which information you need (ROCCAT_CONFIG_SETTINGS or ROCCAT_CONFIG_KEY_MAPPING) or
  * it can be used to specify the button from which you want to get the macro.

src/driver-sinowealth.c

@@ -996,11 +996,13 @@ sinowealth_print_long_lod_and_anglesnapping(struct ratbag_device *device)
 
 	rc = sinowealth_query_read(device, buf, sizeof(buf));
 	if (rc < 0) {
-		log_error(device->ratbag, "Could not read LOD and angle snapping values: %s (%d)\n", strerror(-rc), rc);
+		log_error(device->ratbag,
+			  "Could not read lift-off distance and angle snapping values: %s (%d)\n",
+			  strerror(-rc), rc);
 		return rc;
 	}
 
-	log_info(device->ratbag, "LOD is high: %u\n", buf[2] - 1);
+	log_info(device->ratbag, "Lift-off distance is high: %u\n", buf[2] - 1);
 	log_info(device->ratbag, "Angle snapping enabled: %u\n", buf[3]);
 
 	return 0;

src/driver-steelseries.c

@@ -65,14 +65,14 @@
 #define STEELSERIES_ID_LED			0x5b
 #define STEELSERIES_ID_SAVE			0x59
 #define STEELSERIES_ID_FIRMWARE_PROTOCOL2	0x90
-#define STEELSERIES_ID_SETTTINGS		0x92
+#define STEELSERIES_ID_SETTINGS		0x92
 
 #define STEELSERIES_ID_DPI_PROTOCOL3		0x03
 #define STEELSERIES_ID_REPORT_RATE_PROTOCOL3	0x04
 #define STEELSERIES_ID_LED_PROTOCOL3		0x05
 #define STEELSERIES_ID_SAVE_PROTOCOL3		0x09
 #define STEELSERIES_ID_FIRMWARE_PROTOCOL3	0x10
-#define STEELSERIES_ID_SETTTINGS_PROTOCOL3	0x16
+#define STEELSERIES_ID_SETTINGS_PROTOCOL3	0x16
 
 #define STEELSERIES_BUTTON_OFF			0x00
 #define STEELSERIES_BUTTON_RES_CYCLE		0x30
@@ -263,10 +263,10 @@ steelseries_read_settings(struct ratbag_device *device)
 
 	switch (device_version) {
 	case 2:
-		msg.msg.parameters[0] = STEELSERIES_ID_SETTTINGS;
+		msg.msg.parameters[0] = STEELSERIES_ID_SETTINGS;
 		break;
 	case 3:
-		msg.msg.parameters[0] = STEELSERIES_ID_SETTTINGS_PROTOCOL3;
+		msg.msg.parameters[0] = STEELSERIES_ID_SETTINGS_PROTOCOL3;
 		break;
 	case 1:
 	default:

src/hidpp10.c

@@ -1270,7 +1270,7 @@ hidpp10_onboard_profiles_parse_macro(struct hidpp10_device *device,
 			break;
 		case HIDPP10_MACRO_JUMP_IF_RELEASED_TIMEOUT:
 			m->jump_timeout.timeout = hidpp_be_u16_to_cpu(m->jump_timeout.timeout);
-			hidpp_log_raw(&device->base, "conditional jump to: (0x%02x, 0x%02x) if released whithin %0.03f msecs.\n", m->jump_timeout.page, m->jump_timeout.offset, m->jump_timeout.timeout / 1000.0);
+			hidpp_log_raw(&device->base, "conditional jump to: (0x%02x, 0x%02x) if released within %0.03f msecs.\n", m->jump_timeout.page, m->jump_timeout.offset, m->jump_timeout.timeout / 1000.0);
 			break;
 		case HIDPP10_MACRO_END:
 			break;
@@ -2703,7 +2703,7 @@ hidpp10_get_extended_pairing_information(struct hidpp10_device *dev,
 }
 
 int
-hidpp10_get_firmare_information(struct hidpp10_device *dev,
+hidpp10_get_firmware_information(struct hidpp10_device *dev,
 				uint8_t *major_out,
 				uint8_t *minor_out,
 				uint8_t *build_out)

src/hidpp10.h

@@ -159,9 +159,9 @@ enum hidpp10_hidpp_notifications {
 	 */
 	HIDPP10_NOTIFICATIONS_MOUSE_EXTRA_BUTTONS                   = (1 << 3),
 	/**
-	 * enabled: battery status/milage are reported as HID++ notification
+	 * enabled: battery status/mileage are reported as HID++ notification
 	 * 0x07 or 0x0D (device-dependent)
-	 * disabled: battery status/milage are not reported
+	 * disabled: battery status/mileage are not reported
 	 */
 	HIDPP10_NOTIFICATIONS_BATTERY_STATUS                        = (1 << 4),
 	/**
@@ -714,7 +714,7 @@ hidpp10_get_extended_pairing_information(struct hidpp10_device *dev,
 /* 0xF1: Device Firmware Information                                          */
 /* -------------------------------------------------------------------------- */
 int
-hidpp10_get_firmare_information(struct hidpp10_device *dev,
+hidpp10_get_firmware_information(struct hidpp10_device *dev,
 				uint8_t *major,
 				uint8_t *minor,
 				uint8_t *build_number);

src/hidpp20.h

@@ -266,7 +266,8 @@ int hidpp20_led_sw_control_read_leds(struct hidpp20_device* device,
 
 /**
  * Get the current sw control value
- * @return 0 if the leds are sofware-controlled 1 if they are firmware controlled
+ * @return 0 if the LEDs are software-controlled, 1 if they are firmware
+ * controlled
  */
 bool hidpp20_led_sw_control_get_sw_ctrl(struct hidpp20_device* device);
 
@@ -300,7 +301,7 @@ int hidpp20_led_sw_control_set_led_state(struct hidpp20_device* device,
 
 #define HIDPP_PAGE_KBD_REPROGRAMMABLE_KEYS		0x1b00
 
-enum hidpp2_controL_id_flags {
+enum hidpp2_control_id_flags {
 	HIDPP20_CONTROL_ID_FLAG_NONE = 0,
 	HIDPP20_CONTROL_ID_FLAG_MOUSE_BUTTON = (1 << 0), /**< Is a mouse button */
 	HIDPP20_CONTROL_ID_FLAG_FN_KEY = (1 << 1), /**< Is a fn button */
@@ -794,7 +795,7 @@ struct hidpp20_internal_led {
 		struct hidpp20_led_custom {
 			uint8_t slot;
 			uint16_t init_frame;
-			uint16_t lenght;
+			uint16_t length;
 			uint16_t frame_period;
 			uint8_t intensity;
 		} __attribute__((packed)) custom;

src/liblur.c

@@ -307,7 +307,7 @@ lur_receiver_unref(struct lur_receiver *lur)
 	if (lur->refcount > 0)
 		return NULL;
 
-	/* when we get here, all the devices have alrady been removed from
+	/* when we get here, all the devices have already been removed from
 	 * the receiver */
 
 	hidpp10_device_destroy(lur->hidppdev);

src/libratbag-enums.h

@@ -41,7 +41,7 @@ enum ratbag_error_code {
 	RATBAG_SUCCESS = 0,
 
 	/**
-	 * An error occured on the device. Either the device is not a
+	 * An error occurred on the device. Either the device is not a
 	 * libratbag device or communication with the device failed.
 	 */
 	RATBAG_ERROR_DEVICE = -1000,
@@ -59,7 +59,7 @@ enum ratbag_error_code {
 	RATBAG_ERROR_VALUE = -1002,
 
 	/**
-	 * A low-level system error has occured, e.g. a failure to access
+	 * A low-level system error has occurred, e.g. a failure to access
 	 * files that should be there. This error is usually unrecoverable
 	 * and libratbag will print a log message with details about the
 	 * error.

src/libratbag-hidraw.h

@@ -64,7 +64,7 @@ int ratbag_open_hidraw(struct ratbag_device *device);
  *
  * @param device the ratbag device
  * @param enumeration index of the endpoint
- * @param interal index of hidraw array
+ * @param internal index of hidraw array
  *
  * @return 0 on success or a negative errno on error
  */
@@ -94,7 +94,7 @@ void ratbag_close_hidraw(struct ratbag_device *device);
  * Close a hidraw device associated with the device by the internal index.
  *
  * @param device the ratbag device
- * @param interal index of hidraw array
+ * @param internal index of hidraw array
  */
 void ratbag_close_hidraw_index(struct ratbag_device *device, int idx);
 
@@ -108,7 +108,7 @@ void ratbag_close_hidraw_index(struct ratbag_device *device, int idx);
  * @param rtype HID report type
  * @param reqtype HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
  *
- * @return count of data transfered, or a negative errno on error
+ * @return count of data transferred, or a negative errno on error
  *
  * Same behavior as hid_hw_request, but with raw buffers instead.
  */
@@ -127,7 +127,7 @@ int ratbag_hidraw_raw_request(struct ratbag_device *device, unsigned char report
  * @param buf[out] data returned from device
  * @param len length of buf
  *
- * @return count of data transfered, or a negative errno on error
+ * @return count of data transferred, or a negative errno on error
  *
  * Convenience wrapper around ratbag_hidraw_raw_request()
  */
@@ -145,7 +145,7 @@ int ratbag_hidraw_get_feature_report(struct ratbag_device *device, unsigned char
  * @param buf[in] data returned from device
  * @param len length of buf
  *
- * @return count of data transfered, or a negative errno on error
+ * @return count of data transferred, or a negative errno on error
  *
  * Convenience wrapper around ratbag_hidraw_raw_request()
  */
@@ -158,7 +158,7 @@ int ratbag_hidraw_set_feature_report(struct ratbag_device *device, unsigned char
  * @param buf raw data to transfer
  * @param len length of buf
  *
- * @return count of data transfered, or a negative errno on error
+ * @return count of data transferred, or a negative errno on error
  */
 int ratbag_hidraw_output_report(struct ratbag_device *device, uint8_t *buf, size_t len);
 
@@ -171,7 +171,7 @@ int ratbag_hidraw_output_report(struct ratbag_device *device, uint8_t *buf, size
  * @param len length of buf
  * @param filter filter function
  *
- * @return count of data transfered, or a negative errno on error
+ * @return count of data transferred, or a negative errno on error
  */
 int ratbag_hidraw_read_input_report(struct ratbag_device *device, uint8_t *buf, size_t len,
 				 ratbagd_hidraw_filter_t filter);
@@ -186,7 +186,7 @@ int ratbag_hidraw_read_input_report(struct ratbag_device *device, uint8_t *buf,
  * @param hidrawno index of hidraw array
  * @param filter filter function
  *
- * @return count of data transfered, or a negative errno on error
+ * @return count of data transferred, or a negative errno on error
  */
 int ratbag_hidraw_read_input_report_index(struct ratbag_device *device, uint8_t *buf, size_t len, int hidrawno,
 				 ratbagd_hidraw_filter_t filter);

src/libratbag-private.h

@@ -198,7 +198,7 @@ struct ratbag_driver {
 	int (*commit)(struct ratbag_device *device);
 
 	/**
-	 * Called to mark a previously writen profile as active.
+	 * Called to mark a previously written profile as active.
 	 *
 	 * There should be no need to write the profile here, a
 	 * .write_profile() call is issued before calling this.

src/libratbag.h

@@ -1392,7 +1392,7 @@ ratbag_button_set_special(struct ratbag_button *button,
  * @param[in,out] sz Takes the size of the modifiers array and returns the
  * number of modifiers filled in. sz may be 0 if no modifiers are required.
  *
- * @note The caller must ensure that modifiers is large enough to accomodate
+ * @note The caller must ensure that modifiers is large enough to accommodate
  * for the key combination.
  *
  * @return The button number
@@ -1522,7 +1522,7 @@ ratbag_button_macro_get_event_timeout(struct ratbag_button_macro *macro,
  * to ratbag_button_set_macro() are not reflected in the device until a
  * subsequent call to ratbag_button_set_macro().
  *
- * @param button A previously intialized ratbag button
+ * @param button A previously initialized ratbag button
  * @param macro A fully initialized macro
  *
  * @return 0 on success or nonzero otherwise

test/data-parse-test.py

@@ -76,7 +76,7 @@ def check_ledtypes_str(string: str):
 
     types = string.split(';')
     for t in types:
-        if not t:  # emtpy string if trailing ;
+        if not t:  # empty string if trailing ;
             continue
 
         assertIn(t, permitted_types)

tools/ratbagc.py.in

@@ -60,7 +60,7 @@ class MetaRatbag(type):
 class RatbagErrorCode(metaclass=MetaRatbag):
     SUCCESS = libratbag.RATBAG_SUCCESS
 
-    """An error occured on the device. Either the device is not a libratbag
+    """An error occurred on the device. Either the device is not a libratbag
     device or communication with the device failed."""
     DEVICE = libratbag.RATBAG_ERROR_DEVICE
 
@@ -72,7 +72,7 @@ class RatbagErrorCode(metaclass=MetaRatbag):
     outside of the legal or supported range."""
     VALUE = libratbag.RATBAG_ERROR_VALUE
 
-    """A low-level system error has occured, e.g. a failure to access files
+    """A low-level system error has occurred, e.g. a failure to access files
     that should be there. This error is usually unrecoverable and libratbag will
     print a log message with details about the error."""
     SYSTEM = libratbag.RATBAG_ERROR_SYSTEM
@@ -416,7 +416,7 @@ class RatbagdProfile(metaclass=MetaRatbag):
 
     @property
     def is_active(self):
-        """Returns True if the profile is currenly active, false otherwise."""
+        """Returns True if the profile is currently active, false otherwise."""
         return libratbag.ratbag_profile_is_active(self._profile)
 
     def set_active(self):

tools/ratbagctl.in.in

@@ -593,7 +593,7 @@ nargs = 'nargs'
 choices = 'choices'
 
 # types
-"""an option to interprete as a command (example 'list', 'info')"""
+"""an option to interpret as a command (example 'list', 'info')"""
 command = 'command'
 """an argument that is required for the given command arguments are leaf nodes
 and can not have children

tools/ratbagctl.test.in

@@ -42,7 +42,7 @@ class TestRatbagCtl(unittest.TestCase):
     def setUpClass(cls):
         super().setUpClass()
 
-        # it's a lot easier to debug a validataion failure here than
+        # it's a lot easier to debug a validation failure here than
         # with ratbagd failing
         if cls.json is not None:
             import json

tools/ratbagd.py

@@ -37,7 +37,7 @@ def N_(x):
 class RatbagErrorCode(IntEnum):
     SUCCESS = 0
 
-    """An error occured on the device. Either the device is not a libratbag
+    """An error occurred on the device. Either the device is not a libratbag
     device or communication with the device failed."""
     DEVICE = -1000
 
@@ -49,7 +49,7 @@ class RatbagErrorCode(IntEnum):
     outside of the legal or supported range."""
     VALUE = -1002
 
-    """A low-level system error has occured, e.g. a failure to access files
+    """A low-level system error has occurred, e.g. a failure to access files
     that should be there. This error is usually unrecoverable and libratbag will
     print a log message with details about the error."""
     SYSTEM = -1003