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

From: Helge Deller
Date: Thu Aug 10 2017 - 13:36:22 EST


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@xxxxxx>

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
===============