[PATCH] Documentation: timers: hrtimers: Make hybrid union historical

[PATCH] Documentation: timers: hrtimers: Make hybrid union historical

[Geert Uytterhoeven]

Non-scalar time was removed from the ktime hybrid union in v3.17, and
the union itself followed suit in v4.10.

Make it clear that ktime_t is always a 64bit scalar type, to avoid
confusing the casual reader.

While at it, fix a spelling mistake.

Fixes: 24e4a8c3e8868874 ("ktime: Kill non-scalar ktime_t implementation for 2038")
Fixes: 2456e855354415bf ("ktime: Get rid of the union")
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
Randy did several fruitless attempts to fix the typo before.
---
 Documentation/timers/hrtimers.rst | 19 +++++++------------
 1 file changed, 7 insertions(+), 12 deletions(-)

diff --git a/Documentation/timers/hrtimers.rst b/Documentation/timers/hrtimers.rst
index 7ac448908d1ffd97..f88ff8bae89c8acf 100644
--- a/Documentation/timers/hrtimers.rst
+++ b/Documentation/timers/hrtimers.rst
@@ -123,17 +123,12 @@ equivalent to timer_delete() and timer_delete_sync()] - so there's no direct
 potential for code sharing either.
 
 Basic data types: every time value, absolute or relative, is in a
-special nanosecond-resolution type: ktime_t. The kernel-internal
-representation of ktime_t values and operations is implemented via
-macros and inline functions, and can be switched between a "hybrid
-union" type and a plain "scalar" 64bit nanoseconds representation (at
-compile time). The hybrid union type optimizes time conversions on 32bit
-CPUs. This build-time-selectable ktime_t storage format was implemented
-to avoid the performance impact of 64-bit multiplications and divisions
-on 32bit CPUs. Such operations are frequently necessary to convert
-between the storage formats provided by kernel and userspace interfaces
-and the internal time format. (See include/linux/ktime.h for further
-details.)
+special nanosecond-resolution 64bit type: ktime_t.
+(Originally, the kernel-internal representation of ktime_t values and
+operations was implemented via macros and inline functions, and could be
+switched between a "hybrid union" type and a plain "scalar" 64bit
+nanoseconds representation (at compile time). This was abandoned in the
+context of the Y2038 work.)
 
 hrtimers - rounding of timer values
 -----------------------------------
@@ -148,7 +143,7 @@ a given clock has - be it low-res, high-res, or artificially-low-res.
 hrtimers - testing and verification
 -----------------------------------
 
-We used the high-resolution clock subsystem ontop of hrtimers to verify
+We used the high-resolution clock subsystem on top of hrtimers to verify
 the hrtimer implementation details in praxis, and we also ran the posix
 timer tests in order to ensure specification compliance. We also ran
 tests on low-resolution clocks.
-- 
2.34.1

Re: [PATCH] Documentation: timers: hrtimers: Make hybrid union historical

[Thomas Gleixner]

On Tue, May 02 2023 at 12:05, Geert Uytterhoeven wrote:

> Non-scalar time was removed from the ktime hybrid union in v3.17, and
> the union itself followed suit in v4.10.
>
> Make it clear that ktime_t is always a 64bit scalar type, to avoid
> confusing the casual reader.
>
> While at it, fix a spelling mistake.
>
> Fixes: 24e4a8c3e8868874 ("ktime: Kill non-scalar ktime_t implementation for 2038")
> Fixes: 2456e855354415bf ("ktime: Get rid of the union")
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Reviewed-by: Thomas Gleixner <tglx@linutronix.de>

Re: [PATCH] Documentation: timers: hrtimers: Make hybrid union historical

[Jonathan Corbet]

Thomas Gleixner <tglx@linutronix.de> writes:

> On Tue, May 02 2023 at 12:05, Geert Uytterhoeven wrote:
>
>> Non-scalar time was removed from the ktime hybrid union in v3.17, and
>> the union itself followed suit in v4.10.
>>
>> Make it clear that ktime_t is always a 64bit scalar type, to avoid
>> confusing the casual reader.
>>
>> While at it, fix a spelling mistake.
>>
>> Fixes: 24e4a8c3e8868874 ("ktime: Kill non-scalar ktime_t implementation for 2038")
>> Fixes: 2456e855354415bf ("ktime: Get rid of the union")
>> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
>
> Reviewed-by: Thomas Gleixner <tglx@linutronix.de>

Applied, thanks.

jon