* [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos
@ 2023-09-30 22:14 Randy Dunlap
2023-09-30 22:14 ` Randy Dunlap
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Randy Dunlap @ 2023-09-30 22:14 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Michael Turquette, Stephen Boyd, linux-clk
Fix spelling of "Structure".
Fix multiple kernel-doc warnings:
clk-provider.h:269: warning: Function parameter or member 'recalc_rate' not described in 'clk_ops'
clk-provider.h:468: warning: Function parameter or member 'parent_data' not described in 'clk_hw_register_fixed_rate_with_accuracy_parent_data'
clk-provider.h:468: warning: Excess function parameter 'parent_name' description in 'clk_hw_register_fixed_rate_with_accuracy_parent_data'
clk-provider.h:482: warning: Function parameter or member 'parent_data' not described in 'clk_hw_register_fixed_rate_parent_accuracy'
clk-provider.h:482: warning: Excess function parameter 'parent_name' description in 'clk_hw_register_fixed_rate_parent_accuracy'
clk-provider.h:687: warning: Function parameter or member 'flags' not described in 'clk_divider'
clk-provider.h:1164: warning: Function parameter or member 'flags' not described in 'clk_fractional_divider'
clk-provider.h:1164: warning: Function parameter or member 'approximation' not described in 'clk_fractional_divider'
clk-provider.h:1213: warning: Function parameter or member 'flags' not described in 'clk_multiplier'
Fixes: 9fba738a53dd ("clk: add duty cycle support")
Fixes: b2476490ef11 ("clk: introduce the common clock framework")
Fixes: 2d34f09e79c9 ("clk: fixed-rate: Add support for specifying parents via DT/pointers")
Fixes: f5290d8e4f0c ("clk: asm9260: use parent index to link the reference clock")
Fixes: 9d9f78ed9af0 ("clk: basic clock hardware types")
Fixes: e2d0e90fae82 ("clk: new basic clk type for fractional divider")
Fixes: f2e0a53271a4 ("clk: Add a basic multiplier clock")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org
---
include/linux/clk-provider.h | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff -- a/include/linux/clk-provider.h b/include/linux/clk-provider.h
--- a/include/linux/clk-provider.h
+++ b/include/linux/clk-provider.h
@@ -74,7 +74,7 @@ void clk_hw_forward_rate_request(const s
unsigned long parent_rate);
/**
- * struct clk_duty - Struture encoding the duty cycle ratio of a clock
+ * struct clk_duty - Structure encoding the duty cycle ratio of a clock
*
* @num: Numerator of the duty cycle ratio
* @den: Denominator of the duty cycle ratio
@@ -129,7 +129,7 @@ struct clk_duty {
* @restore_context: Restore the context of the clock after a restoration
* of power.
*
- * @recalc_rate Recalculate the rate of this clock, by querying hardware. The
+ * @recalc_rate: Recalculate the rate of this clock, by querying hardware. The
* parent rate is an input parameter. It is up to the caller to
* ensure that the prepare_mutex is held across this call. If the
* driver cannot figure out a rate for this clock, it must return
@@ -456,7 +456,7 @@ struct clk *clk_register_fixed_rate(stru
* clock with the clock framework
* @dev: device that is registering this clock
* @name: name of this clock
- * @parent_name: name of clock's parent
+ * @parent_data: name of clock's parent
* @flags: framework-specific flags
* @fixed_rate: non-adjustable clock rate
* @fixed_accuracy: non-adjustable clock accuracy
@@ -471,7 +471,7 @@ struct clk *clk_register_fixed_rate(stru
* the clock framework
* @dev: device that is registering this clock
* @name: name of this clock
- * @parent_name: name of clock's parent
+ * @parent_data: name of clock's parent
* @flags: framework-specific flags
* @fixed_rate: non-adjustable clock rate
*/
@@ -649,7 +649,7 @@ struct clk_div_table {
* Clock with an adjustable divider affecting its output frequency. Implements
* .recalc_rate, .set_rate and .round_rate
*
- * Flags:
+ * @flags:
* CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
* register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is
* the raw value read from the register, with the value of zero considered
@@ -1130,11 +1130,12 @@ struct clk_hw *clk_hw_register_fixed_fac
* @mwidth: width of the numerator bit field
* @nshift: shift to the denominator bit field
* @nwidth: width of the denominator bit field
+ * @approximation: clk driver's callback for calculating the divider clock
* @lock: register lock
*
* Clock with adjustable fractional divider affecting its output frequency.
*
- * Flags:
+ * @flags:
* CLK_FRAC_DIVIDER_ZERO_BASED - by default the numerator and denominator
* is the value read from the register. If CLK_FRAC_DIVIDER_ZERO_BASED
* is set then the numerator and denominator are both the value read
@@ -1191,7 +1192,7 @@ void clk_hw_unregister_fractional_divide
* Clock with an adjustable multiplier affecting its output frequency.
* Implements .recalc_rate, .set_rate and .round_rate
*
- * Flags:
+ * @flags:
* CLK_MULTIPLIER_ZERO_BYPASS - By default, the multiplier is the value read
* from the register, with 0 being a valid value effectively
* zeroing the output clock rate. If CLK_MULTIPLIER_ZERO_BYPASS is
^ permalink raw reply [flat|nested] 6+ messages in thread* [PATCH] iosys-map: fix kernel-doc typos
2023-09-30 22:14 [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Randy Dunlap
@ 2023-09-30 22:14 ` Randy Dunlap
2023-09-30 22:14 ` [PATCH] mei: fix doc typos Randy Dunlap
2023-10-13 22:38 ` [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Stephen Boyd
2 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2023-09-30 22:14 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, dri-devel, Thomas Zimmermann
Correct spelling of "beginning".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: dri-devel@lists.freedesktop.org
---
include/linux/iosys-map.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/include/linux/iosys-map.h b/include/linux/iosys-map.h
--- a/include/linux/iosys-map.h
+++ b/include/linux/iosys-map.h
@@ -426,7 +426,7 @@ static inline void iosys_map_memset(stru
* iosys_map_rd_field - Read a member from a struct in the iosys_map
*
* @map__: The iosys_map structure
- * @struct_offset__: Offset from the beggining of the map, where the struct
+ * @struct_offset__: Offset from the beginning of the map, where the struct
* is located
* @struct_type__: The struct describing the layout of the mapping
* @field__: Member of the struct to read
@@ -494,7 +494,7 @@ static inline void iosys_map_memset(stru
* iosys_map_wr_field - Write to a member of a struct in the iosys_map
*
* @map__: The iosys_map structure
- * @struct_offset__: Offset from the beggining of the map, where the struct
+ * @struct_offset__: Offset from the beginning of the map, where the struct
* is located
* @struct_type__: The struct describing the layout of the mapping
* @field__: Member of the struct to read
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH] iosys-map: fix kernel-doc typos
@ 2023-09-30 22:14 ` Randy Dunlap
0 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2023-09-30 22:14 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Thomas Zimmermann, dri-devel
Correct spelling of "beginning".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: dri-devel@lists.freedesktop.org
---
include/linux/iosys-map.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/include/linux/iosys-map.h b/include/linux/iosys-map.h
--- a/include/linux/iosys-map.h
+++ b/include/linux/iosys-map.h
@@ -426,7 +426,7 @@ static inline void iosys_map_memset(stru
* iosys_map_rd_field - Read a member from a struct in the iosys_map
*
* @map__: The iosys_map structure
- * @struct_offset__: Offset from the beggining of the map, where the struct
+ * @struct_offset__: Offset from the beginning of the map, where the struct
* is located
* @struct_type__: The struct describing the layout of the mapping
* @field__: Member of the struct to read
@@ -494,7 +494,7 @@ static inline void iosys_map_memset(stru
* iosys_map_wr_field - Write to a member of a struct in the iosys_map
*
* @map__: The iosys_map structure
- * @struct_offset__: Offset from the beggining of the map, where the struct
+ * @struct_offset__: Offset from the beginning of the map, where the struct
* is located
* @struct_type__: The struct describing the layout of the mapping
* @field__: Member of the struct to read
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] iosys-map: fix kernel-doc typos
2023-09-30 22:14 ` Randy Dunlap
(?)
@ 2023-10-12 7:56 ` Thomas Zimmermann
-1 siblings, 0 replies; 6+ messages in thread
From: Thomas Zimmermann @ 2023-10-12 7:56 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel; +Cc: dri-devel
[-- Attachment #1.1: Type: text/plain, Size: 1778 bytes --]
Hi,
sorry, I missed this patch at first.
Am 01.10.23 um 00:14 schrieb Randy Dunlap:
> Correct spelling of "beginning".
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: dri-devel@lists.freedesktop.org
Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>
> ---
> include/linux/iosys-map.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/include/linux/iosys-map.h b/include/linux/iosys-map.h
> --- a/include/linux/iosys-map.h
> +++ b/include/linux/iosys-map.h
> @@ -426,7 +426,7 @@ static inline void iosys_map_memset(stru
> * iosys_map_rd_field - Read a member from a struct in the iosys_map
> *
> * @map__: The iosys_map structure
> - * @struct_offset__: Offset from the beggining of the map, where the struct
> + * @struct_offset__: Offset from the beginning of the map, where the struct
> * is located
> * @struct_type__: The struct describing the layout of the mapping
> * @field__: Member of the struct to read
> @@ -494,7 +494,7 @@ static inline void iosys_map_memset(stru
> * iosys_map_wr_field - Write to a member of a struct in the iosys_map
> *
> * @map__: The iosys_map structure
> - * @struct_offset__: Offset from the beggining of the map, where the struct
> + * @struct_offset__: Offset from the beginning of the map, where the struct
> * is located
> * @struct_type__: The struct describing the layout of the mapping
> * @field__: Member of the struct to read
--
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Frankenstrasse 146, 90461 Nuernberg, Germany
GF: Ivo Totev, Andrew Myers, Andrew McDonald, Boudien Moerman
HRB 36809 (AG Nuernberg)
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 840 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH] mei: fix doc typos
2023-09-30 22:14 [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Randy Dunlap
2023-09-30 22:14 ` Randy Dunlap
@ 2023-09-30 22:14 ` Randy Dunlap
2023-10-13 22:38 ` [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Stephen Boyd
2 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2023-09-30 22:14 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Tomas Winkler, Greg Kroah-Hartman
Fix grammar and punctuation.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Tomas Winkler <tomas.winkler@intel.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
include/uapi/linux/mei.h | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff -- a/include/uapi/linux/mei.h b/include/uapi/linux/mei.h
--- a/include/uapi/linux/mei.h
+++ b/include/uapi/linux/mei.h
@@ -14,8 +14,8 @@
* FW Client (given by UUID). This opens a communication channel
* between a host client and a FW client. From this point every read and write
* will communicate with the associated FW client.
- * Only in close() (file_operation release()) the communication between
- * the clients is disconnected
+ * Only in close() (file_operation release()) is the communication between
+ * the clients disconnected.
*
* The IOCTL argument is a struct with a union that contains
* the input parameter and the output parameter for this IOCTL.
@@ -51,7 +51,7 @@ struct mei_connect_client_data {
* DOC: set and unset event notification for a connected client
*
* The IOCTL argument is 1 for enabling event notification and 0 for
- * disabling the service
+ * disabling the service.
* Return: -EOPNOTSUPP if the devices doesn't support the feature
*/
#define IOCTL_MEI_NOTIFY_SET _IOW('H', 0x02, __u32)
@@ -59,8 +59,8 @@ struct mei_connect_client_data {
/**
* DOC: retrieve notification
*
- * The IOCTL output argument is 1 if an event was is pending and 0 otherwise
- * the ioctl has to be called in order to acknowledge pending event
+ * The IOCTL output argument is 1 if an event was pending and 0 otherwise.
+ * The ioctl has to be called in order to acknowledge pending event.
*
* Return: -EOPNOTSUPP if the devices doesn't support the feature
*/
@@ -98,14 +98,14 @@ struct mei_connect_client_data_vtag {
* FW Client (given by UUID), and virtual tag (vtag).
* The IOCTL opens a communication channel between a host client and
* a FW client on a tagged channel. From this point on, every read
- * and write will communicate with the associated FW client with
+ * and write will communicate with the associated FW client
* on the tagged channel.
* Upone close() the communication is terminated.
*
* The IOCTL argument is a struct with a union that contains
* the input parameter and the output parameter for this IOCTL.
*
- * The input parameter is UUID of the FW Client, a vtag [0,255]
+ * The input parameter is UUID of the FW Client, a vtag [0,255].
* The output parameter is the properties of the FW client
* (FW protocool version and max message size).
*
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos
2023-09-30 22:14 [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Randy Dunlap
2023-09-30 22:14 ` Randy Dunlap
2023-09-30 22:14 ` [PATCH] mei: fix doc typos Randy Dunlap
@ 2023-10-13 22:38 ` Stephen Boyd
2 siblings, 0 replies; 6+ messages in thread
From: Stephen Boyd @ 2023-10-13 22:38 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel; +Cc: Randy Dunlap, Michael Turquette, linux-clk
Quoting Randy Dunlap (2023-09-30 15:14:26)
> Fix spelling of "Structure".
>
> Fix multiple kernel-doc warnings:
>
> clk-provider.h:269: warning: Function parameter or member 'recalc_rate' not described in 'clk_ops'
> clk-provider.h:468: warning: Function parameter or member 'parent_data' not described in 'clk_hw_register_fixed_rate_with_accuracy_parent_data'
> clk-provider.h:468: warning: Excess function parameter 'parent_name' description in 'clk_hw_register_fixed_rate_with_accuracy_parent_data'
> clk-provider.h:482: warning: Function parameter or member 'parent_data' not described in 'clk_hw_register_fixed_rate_parent_accuracy'
> clk-provider.h:482: warning: Excess function parameter 'parent_name' description in 'clk_hw_register_fixed_rate_parent_accuracy'
> clk-provider.h:687: warning: Function parameter or member 'flags' not described in 'clk_divider'
> clk-provider.h:1164: warning: Function parameter or member 'flags' not described in 'clk_fractional_divider'
> clk-provider.h:1164: warning: Function parameter or member 'approximation' not described in 'clk_fractional_divider'
> clk-provider.h:1213: warning: Function parameter or member 'flags' not described in 'clk_multiplier'
>
> Fixes: 9fba738a53dd ("clk: add duty cycle support")
> Fixes: b2476490ef11 ("clk: introduce the common clock framework")
> Fixes: 2d34f09e79c9 ("clk: fixed-rate: Add support for specifying parents via DT/pointers")
> Fixes: f5290d8e4f0c ("clk: asm9260: use parent index to link the reference clock")
> Fixes: 9d9f78ed9af0 ("clk: basic clock hardware types")
> Fixes: e2d0e90fae82 ("clk: new basic clk type for fractional divider")
> Fixes: f2e0a53271a4 ("clk: Add a basic multiplier clock")
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Michael Turquette <mturquette@baylibre.com>
> Cc: Stephen Boyd <sboyd@kernel.org>
> Cc: linux-clk@vger.kernel.org
> ---
Applied to clk-next
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-10-13 22:38 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-30 22:14 [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Randy Dunlap
2023-09-30 22:14 ` [PATCH] iosys-map: fix kernel-doc typos Randy Dunlap
2023-09-30 22:14 ` Randy Dunlap
2023-10-12 7:56 ` Thomas Zimmermann
2023-09-30 22:14 ` [PATCH] mei: fix doc typos Randy Dunlap
2023-10-13 22:38 ` [PATCH] clk: linux/clk-provider.h: fix kernel-doc warnings and typos Stephen Boyd
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.