diff mbox series

docs: printk-formats: add ptrdiff_t type to printk-formats

Message ID 20191001100449.19481-1-miles.chen@mediatek.com (mailing list archive)
State New, archived
Headers show
Series docs: printk-formats: add ptrdiff_t type to printk-formats | expand

Commit Message

Miles Chen Oct. 1, 2019, 10:04 a.m. UTC
When print the difference between two pointers, we should use
the ptrdiff_t modifier %t.

Signed-off-by: Miles Chen <miles.chen@mediatek.com>
---
 Documentation/core-api/printk-formats.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Jonathan Corbet Nov. 7, 2019, 8:10 p.m. UTC | #1
On Tue, 1 Oct 2019 18:04:49 +0800
Miles Chen <miles.chen@mediatek.com> wrote:

> When print the difference between two pointers, we should use
> the ptrdiff_t modifier %t.
> 
> Signed-off-by: Miles Chen <miles.chen@mediatek.com>
> ---
>  Documentation/core-api/printk-formats.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)

Applied, thanks.

jon
diff mbox series

Patch

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index ecbebf4ca8e7..8a0f49cd158b 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -135,6 +135,20 @@  equivalent to %lx (or %lu). %px is preferred because it is more uniquely
 grep'able. If in the future we need to modify the way the kernel handles
 printing pointers we will be better equipped to find the call sites.
 
+Pointer Differences
+-------------------
+
+::
+
+	%td	2560
+	%tx	a00
+
+For printing the pointer differences, use the %t modifier for ptrdiff_t.
+
+Example::
+
+	printk("test: difference between pointers: %td\n", ptr2 - ptr1);
+
 Struct Resources
 ----------------