[PATCH] printk-formats.txt: Add examples for %pS and %pF

From	Helge Deller <deller@gmx.de>
Newsgroups	linux.kernel
Subject	[PATCH] printk-formats.txt: Add examples for %pS and %pF
Date	2017-08-10 19:40 +0200
Message-ID	<ucZB7-fd-11@gated-at.bofh.it> (permalink)
Organization	linux.* mail to news gateway

Show all headers | View raw

Sometimes people seems unclear when to use the %pS or %pF printk format.
Adding some examples may help to avoid such mistakes.

See for example commit 51d96dc2e2dc ("random: fix warning message on ia64 and
parisc") which fixed such a wrong format string.

Signed-off-by: Helge Deller <deller@gmx.de>

diff --git a/Documentation/printk-formats.txt b/Documentation/printk-formats.txt
index 65ea591..be8c05b 100644
--- a/Documentation/printk-formats.txt
+++ b/Documentation/printk-formats.txt
@@ -73,6 +73,12 @@ actually function descriptors which must first be resolved. The ``F`` and
 ``f`` specifiers perform this resolution and then provide the same
 functionality as the ``S`` and ``s`` specifiers.
 
+Examples::
+
+	printk("Called from %pS.\n", __builtin_return_address(0));
+	printk("Called from %pS.\n", (void *)regs->ip);
+	printk("Called from %pF.\n", &gettimeofday);
+
 Kernel Pointers
 ===============

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[PATCH] printk-formats.txt: Add examples for %pS and %pF Helge Deller <deller@gmx.de> - 2017-08-10 19:40 +0200
  Re: [PATCH] printk-formats.txt: Add examples for %pS and %pF Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com> - 2017-08-11 02:20 +0200
    Re: [PATCH] printk-formats.txt: Add examples for %pS and %pF Helge Deller <deller@gmx.de> - 2017-08-11 09:40 +0200

csiph-web