2021-06-09 19:53:25

by Carlos Llamas

Subject: [PATCH] docs: printk-formats: update size-casting examples

Since commit 72deb455b5ec ("block: remove CONFIG_LBDAF") sector_t and
blkcnt_t types are no longer variable in size, making them unsuitable
examples for casting to the largest possible type. This patch replaces
such examples with cycles_t and blk_status_t types, whose sizes depend
on architecture and config options respectively.

Signed-off-by: Carlos Llamas <[email protected]>
---
Documentation/core-api/printk-formats.rst | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index f063a384c7c8..385c0cc52f1f 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -37,14 +37,13 @@ Integer types
u64 %llu or %llx


-If <type> is dependent on a config option for its size (e.g., sector_t,
-blkcnt_t) or is architecture-dependent for its size (e.g., tcflag_t), use a
-format specifier of its largest possible type and explicitly cast to it.
+If <type> is architecture-dependent for its size (e.g., cycles_t, tcflag_t) or
+is dependent on a config option for its size (e.g., blk_status_t), use a format
+specifier of its largest possible type and explicitly cast to it.

Example::

- printk("test: sector number/total blocks: %llu/%llu\n",
- (unsigned long long)sector, (unsigned long long)blockcount);
+ printk("test: latency: %llu cycles\n", (unsigned long long)time);

Reminder: sizeof() returns type size_t.

--
2.32.0.272.g935e593368-goog

2021-06-13 23:11:50

by Jonathan Corbet

Subject: Re: [PATCH] docs: printk-formats: update size-casting examples

Carlos Llamas <[email protected]> writes:

> Since commit 72deb455b5ec ("block: remove CONFIG_LBDAF") sector_t and
> blkcnt_t types are no longer variable in size, making them unsuitable
> examples for casting to the largest possible type. This patch replaces
> such examples with cycles_t and blk_status_t types, whose sizes depend
> on architecture and config options respectively.
>
> Signed-off-by: Carlos Llamas <[email protected]>
> ---
> Documentation/core-api/printk-formats.rst | 9 ++++-----
> 1 file changed, 4 insertions(+), 5 deletions(-)

Applied, thanks.

jon