Skip to contentSkip to conversation

time: revert cleanup on msecs_to_jiffies() documentation

PATCH Applied Miguel Ojeda 3 participants 7 messages Oct 25, 2024 – Oct 26, 2024 Timekeeping, clocksource core, NTP, alarmtimer

lore
Share & tools
lore
#0 lore raw

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

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")
---
 kernel/time/time.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/time/time.c +1 -1
index 642647f5046b..e1879ca32103 100644
@@ -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

Signature · 1 line
2.47.0
#1 lore raw

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

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")
---
 include/linux/jiffies.h | 2 +-
 kernel/time/time.c      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
include/linux/jiffies.h +1 -1
index 1220f0fbe5bf..5d21dacd62bc 100644
@@ -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
kernel/time/time.c +1 -1
index e1879ca32103..1ad88e97b4eb 100644
@@ -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

merge bot Applied
#2 lore raw

[tip: timers/core] time: Fix references to _msecs_to_jiffies() handling of values

The following commit has been merged into the timers/core branch of tip:

The following commit has been merged into the timers/core branch of tip:

Commit-ID:     9824e79077e8022e24d760333633ffc760b09270
Gitweb:        https://git.kernel.org/tip/9824e79077e8022e24d760333633ffc760b09270
Author:        Miguel Ojeda <[email protected]>
AuthorDate:    Fri, 25 Oct 2024 13:01:41 +02:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Fri, 25 Oct 2024 16:48:10 +02:00

time: Fix references to _msecs_to_jiffies() handling of values

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")
---
 include/linux/jiffies.h | 2 +-
 kernel/time/time.c      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
include/linux/jiffies.h +1 -1
index 1220f0f..5d21dac 100644
@@ -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
kernel/time/time.c +1 -1
index b1809a1..1b69caa 100644
@@ -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
merge bot Applied
#3 lore raw

[tip: timers/core] time: Fix references to _msecs_to_jiffies() handling of values

In reply to Miguel Ojeda
The following commit has been merged into the timers/core branch of tip:

The following commit has been merged into the timers/core branch of tip:

Commit-ID:     92b043fd995a63a57aae29ff85a39b6f30cd440c
Gitweb:        https://git.kernel.org/tip/92b043fd995a63a57aae29ff85a39b6f30cd440c
Author:        Miguel Ojeda <[email protected]>
AuthorDate:    Fri, 25 Oct 2024 13:01:41 +02:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Fri, 25 Oct 2024 19:50:10 +02:00

time: Fix references to _msecs_to_jiffies() handling of values

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")
---
 include/linux/jiffies.h | 2 +-
 kernel/time/time.c      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
include/linux/jiffies.h +1 -1
index 1220f0f..5d21dac 100644
@@ -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
kernel/time/time.c +1 -1
index b1809a1..1b69caa 100644
@@ -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
merge bot Applied
#4 lore raw

[tip: timers/core] time: Partially revert cleanup on msecs_to_jiffies() documentation

In reply to Miguel Ojeda
The following commit has been merged into the timers/core branch of tip:

The following commit has been merged into the timers/core branch of tip:

Commit-ID:     0592cdd59cb09f7ab8bda55f77952f3ce2edaa04
Gitweb:        https://git.kernel.org/tip/0592cdd59cb09f7ab8bda55f77952f3ce2edaa04
Author:        Miguel Ojeda <[email protected]>
AuthorDate:    Fri, 25 Oct 2024 13:01:40 +02:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Fri, 25 Oct 2024 16:48:10 +02:00

time: Partially revert cleanup on msecs_to_jiffies() documentation

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")
---
 kernel/time/time.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/time/time.c +1 -1
index 5984d4a..b1809a1 100644
@@ -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
merge bot Applied
#5 lore raw

[tip: timers/core] time: Partially revert cleanup on msecs_to_jiffies() documentation

In reply to Miguel Ojeda
The following commit has been merged into the timers/core branch of tip:

The following commit has been merged into the timers/core branch of tip:

Commit-ID:     b05aefc1f5886c8aece650c9c1639c87b976191a
Gitweb:        https://git.kernel.org/tip/b05aefc1f5886c8aece650c9c1639c87b976191a
Author:        Miguel Ojeda <[email protected]>
AuthorDate:    Fri, 25 Oct 2024 13:01:40 +02:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Fri, 25 Oct 2024 19:49:16 +02:00

time: Partially revert cleanup on msecs_to_jiffies() documentation

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")
---
 kernel/time/time.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/time/time.c +1 -1
index 5984d4a..b1809a1 100644
@@ -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
Acked-by on v1 1/2
#6 lore raw
In reply to Miguel Ojeda
Quoted 10 lines · 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")

Thanks.

Quoted 19 lines
---
 kernel/time/time.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/time/time.c +1 -1
index 642647f5046b..e1879ca32103 100644
@@ -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

Signature · 1 line
~Randy