[PATCH] vdso/datapage: Correct the vdso_timestamp kernel-doc

[PATCH] vdso/datapage: Correct the vdso_timestamp kernel-doc

[Zhan Xusheng]

From: Zhan Xusheng <zhanxusheng@xiaomi.com>

The kernel-doc of struct vdso_timestamp describes where its two fields
come from by naming the members that define them.

Both names moved.  cycle_last and shift are members of struct vdso_clock,
and the array subscript in "vdso_time_data[x].shift" refers to a datapage
layout that no longer exists.

Name the struct that holds them now.

Fixes: 886653e36639 ("vdso: Rework struct vdso_time_data and introduce struct vdso_clock")
Signed-off-by: Zhan Xusheng <zhanxusheng@xiaomi.com>
---
 include/vdso/datapage.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/vdso/datapage.h b/include/vdso/datapage.h
index 5c4dac5bdda9..49d508126878 100644
--- a/include/vdso/datapage.h
+++ b/include/vdso/datapage.h
@@ -48,11 +48,11 @@ struct vdso_arch_data {
  *
  * There is one vdso_timestamp object in vvar for each vDSO-accelerated
  * clock_id. For high-resolution clocks, this encodes the time
- * corresponding to vdso_time_data.cycle_last. For coarse clocks this encodes
+ * corresponding to vdso_clock.cycle_last. For coarse clocks this encodes
  * the actual time.
  *
  * To be noticed that for highres clocks nsec is left-shifted by
- * vdso_time_data[x].shift.
+ * vdso_clock.shift.
  */
 struct vdso_timestamp {
 	u64	sec;
-- 
2.43.0

[tip: timers/vdso] vdso/datapage: Correct the vdso_timestamp kernel-doc

[tip-bot2 for Zhan Xusheng]

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

Commit-ID:     a877a3089b96ac0f7f8aa65a05ae5a441dbae1a5
Gitweb:        https://git.kernel.org/tip/a877a3089b96ac0f7f8aa65a05ae5a441dbae1a5
Author:        Zhan Xusheng <zhanxusheng@xiaomi.com>
AuthorDate:    Tue, 10 Nov 2026 14:22:07 +08:00
Committer:     Thomas Gleixner <tglx@kernel.org>
CommitterDate: Thu, 12 Nov 2026 20:11:07 +01:00

vdso/datapage: Correct the vdso_timestamp kernel-doc

The kernel-doc of struct vdso_timestamp describes where its two fields come
from by naming the members that define them.

Both names changed.  cycle_last and shift are members of struct vdso_clock,
and the array subscript in "vdso_time_data[x].shift" refers to a datapage
layout that no longer exists.

Rename the references accordingly.

Fixes: 886653e36639 ("vdso: Rework struct vdso_time_data and introduce struct vdso_clock")
Signed-off-by: Zhan Xusheng <zhanxusheng@xiaomi.com>
Signed-off-by: Thomas Gleixner <tglx@kernel.org>
Link: https://patch.msgid.link/20261110062207.213676-1-zhanxusheng1024@gmail.com
---
 include/vdso/datapage.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/vdso/datapage.h b/include/vdso/datapage.h
index 5c4dac5..49d5081 100644
--- a/include/vdso/datapage.h
+++ b/include/vdso/datapage.h
@@ -48,11 +48,11 @@ struct vdso_arch_data {
  *
  * There is one vdso_timestamp object in vvar for each vDSO-accelerated
  * clock_id. For high-resolution clocks, this encodes the time
- * corresponding to vdso_time_data.cycle_last. For coarse clocks this encodes
+ * corresponding to vdso_clock.cycle_last. For coarse clocks this encodes
  * the actual time.
  *
  * To be noticed that for highres clocks nsec is left-shifted by
- * vdso_time_data[x].shift.
+ * vdso_clock.shift.
  */
 struct vdso_timestamp {
 	u64	sec;