[PATCH 1/2] time: revert cleanup on msecs_to_jiffies() documentation

[PATCH 1/2] time: revert cleanup on msecs_to_jiffies() documentation

[Miguel Ojeda]

The documentation's intention is to compare `msecs_to_jiffies` (first
sentence) with `__msecs_to_jiffies` (second sentence), which is what the
original documentation did. One of the cleanups in commit f3cb80804b82
("time: Fix various kernel-doc problems") may have thought the paragraph
was talking about the latter since that is what it is being documented.

Thus revert that part of the change.

Fixes: f3cb80804b82 ("time: Fix various kernel-doc problems")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 kernel/time/time.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/time/time.c b/kernel/time/time.c
index 642647f5046b..e1879ca32103 100644
--- a/kernel/time/time.c
+++ b/kernel/time/time.c
@@ -558,7 +558,7 @@ EXPORT_SYMBOL(ns_to_timespec64);
  *   handling any 32-bit overflows.
  *   for the details see __msecs_to_jiffies()
  *
- * __msecs_to_jiffies() checks for the passed in value being a constant
+ * msecs_to_jiffies() checks for the passed in value being a constant
  * via __builtin_constant_p() allowing gcc to eliminate most of the
  * code, __msecs_to_jiffies() is called if the value passed does not
  * allow constant folding and the actual conversion must be done at

base-commit: 42f7652d3eb527d03665b09edac47f85fb600924
-- 
2.47.0

[PATCH 2/2] time: fix references to _msecs_to_jiffies handling of values

[Miguel Ojeda]

The details about the handling of the "normal" values were moved
to the `_msecs_to_jiffies` helpers in commit ca42aaf0c861 ("time:
Refactor msecs_to_jiffies"). However, the same commit still mentioned
`__msecs_to_jiffies` in the added documentation.

Thus point to `_msecs_to_jiffies` instead.

Fixes: ca42aaf0c861 ("time: Refactor msecs_to_jiffies")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 include/linux/jiffies.h | 2 +-
 kernel/time/time.c      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h
index 1220f0fbe5bf..5d21dacd62bc 100644
--- a/include/linux/jiffies.h
+++ b/include/linux/jiffies.h
@@ -502,7 +502,7 @@ static inline unsigned long _msecs_to_jiffies(const unsigned int m)
  * - all other values are converted to jiffies by either multiplying
  *   the input value by a factor or dividing it with a factor and
  *   handling any 32-bit overflows.
- *   for the details see __msecs_to_jiffies()
+ *   for the details see _msecs_to_jiffies()
  *
  * msecs_to_jiffies() checks for the passed in value being a constant
  * via __builtin_constant_p() allowing gcc to eliminate most of the
diff --git a/kernel/time/time.c b/kernel/time/time.c
index e1879ca32103..1ad88e97b4eb 100644
--- a/kernel/time/time.c
+++ b/kernel/time/time.c
@@ -556,7 +556,7 @@ EXPORT_SYMBOL(ns_to_timespec64);
  * - all other values are converted to jiffies by either multiplying
  *   the input value by a factor or dividing it with a factor and
  *   handling any 32-bit overflows.
- *   for the details see __msecs_to_jiffies()
+ *   for the details see _msecs_to_jiffies()
  *
  * msecs_to_jiffies() checks for the passed in value being a constant
  * via __builtin_constant_p() allowing gcc to eliminate most of the
--
2.47.0

Re: [PATCH 1/2] time: revert cleanup on msecs_to_jiffies() documentation

[Randy Dunlap]

On 10/25/24 4:01 AM, Miguel Ojeda wrote:
> The documentation's intention is to compare `msecs_to_jiffies` (first
> sentence) with `__msecs_to_jiffies` (second sentence), which is what the
> original documentation did. One of the cleanups in commit f3cb80804b82
> ("time: Fix various kernel-doc problems") may have thought the paragraph
> was talking about the latter since that is what it is being documented.
> 
> Thus revert that part of the change.
> 
> Fixes: f3cb80804b82 ("time: Fix various kernel-doc problems")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

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

Thanks.

> ---
>  kernel/time/time.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/time/time.c b/kernel/time/time.c
> index 642647f5046b..e1879ca32103 100644
> --- a/kernel/time/time.c
> +++ b/kernel/time/time.c
> @@ -558,7 +558,7 @@ EXPORT_SYMBOL(ns_to_timespec64);
>   *   handling any 32-bit overflows.
>   *   for the details see __msecs_to_jiffies()
>   *
> - * __msecs_to_jiffies() checks for the passed in value being a constant
> + * msecs_to_jiffies() checks for the passed in value being a constant
>   * via __builtin_constant_p() allowing gcc to eliminate most of the
>   * code, __msecs_to_jiffies() is called if the value passed does not
>   * allow constant folding and the actual conversion must be done at
> 
> base-commit: 42f7652d3eb527d03665b09edac47f85fb600924

-- 
~Randy