diff mbox series

mfd: cros_ec: update module description

Message ID 20240819102342.5265-1-tzungbi@kernel.org (mailing list archive)
State Superseded
Headers show
Series mfd: cros_ec: update module description | expand

Commit Message

Tzung-Bi Shih Aug. 19, 2024, 10:23 a.m. UTC
From: Tzung-Bi Shih <tzungbi@kernel.org>

The module description can be backtracked to commit e7c256fbfb15
("platform/chrome: Add Chrome OS EC userspace device interface").

The description became out-of-date after a bunch of changes.  E.g.:
- 5668bfdd90cd ("platform/chrome: cros_ec_dev - Register cros-ec sensors").
- ea01a31b9058 ("cros_ec: Split cros_ec_devs module").
- 5e0115581bbc ("cros_ec: Move cros_ec_dev module to drivers/mfd").

Update the description.

Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
---
 drivers/mfd/cros_ec_dev.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Lee Jones Aug. 22, 2024, 10:06 a.m. UTC | #1
On Mon, 19 Aug 2024, tzungbi@kernel.org wrote:

> From: Tzung-Bi Shih <tzungbi@kernel.org>
> 
> The module description can be backtracked to commit e7c256fbfb15
> ("platform/chrome: Add Chrome OS EC userspace device interface").
> 
> The description became out-of-date after a bunch of changes.  E.g.:
> - 5668bfdd90cd ("platform/chrome: cros_ec_dev - Register cros-ec sensors").
> - ea01a31b9058 ("cros_ec: Split cros_ec_devs module").
> - 5e0115581bbc ("cros_ec: Move cros_ec_dev module to drivers/mfd").
> 
> Update the description.
> 
> Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
> ---
>  drivers/mfd/cros_ec_dev.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/mfd/cros_ec_dev.c b/drivers/mfd/cros_ec_dev.c
> index 55b30076763b..8a22bd31a707 100644
> --- a/drivers/mfd/cros_ec_dev.c
> +++ b/drivers/mfd/cros_ec_dev.c
> @@ -1,6 +1,6 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
>  /*
> - * cros_ec_dev - expose the Chrome OS Embedded Controller to user-space
> + * ChromeOS Embedded Controller MFD
>   *
>   * Copyright (C) 2014 Google, Inc.
>   */
> @@ -377,6 +377,6 @@ module_init(cros_ec_dev_init);
>  module_exit(cros_ec_dev_exit);
>  
>  MODULE_AUTHOR("Bill Richardson <wfrichar@chromium.org>");
> -MODULE_DESCRIPTION("Userspace interface to the Chrome OS Embedded Controller");
> +MODULE_DESCRIPTION("ChromeOS Embedded Controller MFD");

Please drop the term MFD - there is no such thing.

>  MODULE_VERSION("1.0");
>  MODULE_LICENSE("GPL");
> -- 
> 2.43.0
>
diff mbox series

Patch

diff --git a/drivers/mfd/cros_ec_dev.c b/drivers/mfd/cros_ec_dev.c
index 55b30076763b..8a22bd31a707 100644
--- a/drivers/mfd/cros_ec_dev.c
+++ b/drivers/mfd/cros_ec_dev.c
@@ -1,6 +1,6 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * cros_ec_dev - expose the Chrome OS Embedded Controller to user-space
+ * ChromeOS Embedded Controller MFD
  *
  * Copyright (C) 2014 Google, Inc.
  */
@@ -377,6 +377,6 @@  module_init(cros_ec_dev_init);
 module_exit(cros_ec_dev_exit);
 
 MODULE_AUTHOR("Bill Richardson <wfrichar@chromium.org>");
-MODULE_DESCRIPTION("Userspace interface to the Chrome OS Embedded Controller");
+MODULE_DESCRIPTION("ChromeOS Embedded Controller MFD");
 MODULE_VERSION("1.0");
 MODULE_LICENSE("GPL");