[PATCH] of: Clarify OF device context in of_match_device() comment

[PATCH] of: Clarify OF device context in of_match_device() comment

[Bagas Sanjaya]

Open Firmware abbreviation (OF) in of_match_device() comment is written
in lowercase instead, which is mistaken for prepositional word "of"
([1], [2], [3], [4]) duplicate.

Clarify the context.

Link: https://lore.kernel.org/all/CAL_JsqLypcBCOVZ8yYWK0J_xc2Vcr+ANrX_3v4vN55Srp4RknQ@mail.gmail.com/ [1]
Link: https://lore.kernel.org/all/20220926185852.GA2581083-robh@kernel.org/ [2]
Link: https://lore.kernel.org/all/CAL_JsqL4GvgFYzGUfhW5pvm4wYGrFaj6gHOYZjnOMuk2zCz67w@mail.gmail.com/ [3]
Link: https://lore.kernel.org/all/20220627173825.GA2637590-robh@kernel.org/ [4]
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/of/device.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/of/device.c b/drivers/of/device.c
index c80426510ec2c0..f7e75e5276677e 100644
--- a/drivers/of/device.c
+++ b/drivers/of/device.c
@@ -17,8 +17,8 @@
 
 /**
  * of_match_device - Tell if a struct device matches an of_device_id list
- * @matches: array of of device match structures to search in
- * @dev: the of device structure to match against
+ * @matches: array of of_device_id match structures to search in
+ * @dev: the OF device structure to match against
  *
  * Used by a driver to check whether an platform_device present in the
  * system is in its list of supported devices.

base-commit: 0121898ec05fa4c1f566fc05c7e8b3caf0998f97
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] of: Clarify OF device context in of_match_device() comment

[Randy Dunlap]

On 7/29/25 6:31 PM, Bagas Sanjaya wrote:
> Open Firmware abbreviation (OF) in of_match_device() comment is written
> in lowercase instead, which is mistaken for prepositional word "of"
> ([1], [2], [3], [4]) duplicate.
> 
> Clarify the context.
> 
> Link: https://lore.kernel.org/all/CAL_JsqLypcBCOVZ8yYWK0J_xc2Vcr+ANrX_3v4vN55Srp4RknQ@mail.gmail.com/ [1]
> Link: https://lore.kernel.org/all/20220926185852.GA2581083-robh@kernel.org/ [2]
> Link: https://lore.kernel.org/all/CAL_JsqL4GvgFYzGUfhW5pvm4wYGrFaj6gHOYZjnOMuk2zCz67w@mail.gmail.com/ [3]
> Link: https://lore.kernel.org/all/20220627173825.GA2637590-robh@kernel.org/ [4]
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Wow, that's confusing (the "of" parts).
Hopefully Rob won't mind losing the entertainment factor here.


Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.


> ---
>  drivers/of/device.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/of/device.c b/drivers/of/device.c
> index c80426510ec2c0..f7e75e5276677e 100644
> --- a/drivers/of/device.c
> +++ b/drivers/of/device.c
> @@ -17,8 +17,8 @@
>  
>  /**
>   * of_match_device - Tell if a struct device matches an of_device_id list
> - * @matches: array of of device match structures to search in
> - * @dev: the of device structure to match against
> + * @matches: array of of_device_id match structures to search in
> + * @dev: the OF device structure to match against
>   *
>   * Used by a driver to check whether an platform_device present in the
>   * system is in its list of supported devices.
> 
> base-commit: 0121898ec05fa4c1f566fc05c7e8b3caf0998f97

-- 
~Randy

Re: [PATCH] of: Clarify OF device context in of_match_device() comment

[Rob Herring (Arm)]

On Wed, 30 Jul 2025 08:31:13 +0700, Bagas Sanjaya wrote:
> Open Firmware abbreviation (OF) in of_match_device() comment is written
> in lowercase instead, which is mistaken for prepositional word "of"
> ([1], [2], [3], [4]) duplicate.
> 
> Clarify the context.
> 
> Link: https://lore.kernel.org/all/CAL_JsqLypcBCOVZ8yYWK0J_xc2Vcr+ANrX_3v4vN55Srp4RknQ@mail.gmail.com/ [1]
> Link: https://lore.kernel.org/all/20220926185852.GA2581083-robh@kernel.org/ [2]
> Link: https://lore.kernel.org/all/CAL_JsqL4GvgFYzGUfhW5pvm4wYGrFaj6gHOYZjnOMuk2zCz67w@mail.gmail.com/ [3]
> Link: https://lore.kernel.org/all/20220627173825.GA2637590-robh@kernel.org/ [4]
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  drivers/of/device.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Applied, thanks!