printk: clarify the documentation for plain pointer printing
authorVlastimil Babka <vbabka@suse.cz>
Thu, 25 Feb 2021 16:46:39 +0000 (17:46 +0100)
committerPetr Mladek <pmladek@suse.com>
Wed, 7 Apr 2021 11:20:59 +0000 (13:20 +0200)
commita48849e2358ecf1a347a03b33dc27b9b2f25f8fd
treef47ee70b3fb98b2b99b5ac451a4d480bbdbbb132
parentea35d8677811296730e762a2888cda3f01d13a89
printk: clarify the documentation for plain pointer printing

We have several modifiers for plain pointers (%p, %px and %pK) and now
also the no_hash_pointers boot parameter. The documentation should help
to choose which variant to use. Importantly, we should discourage %px
in favor of %p (with the new boot parameter when debugging), and stress
that %pK should be only used for procfs and similar files, not dmesg
buffer. This patch clarifies the documentation in that regard.

Signed-off-by: Vlastimil Babka <vbabka@suse.cz>
Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Reviewed-by: Petr Mladek <pmladek@suse.com>
Signed-off-by: Petr Mladek <pmladek@suse.com>
Link: https://lore.kernel.org/r/20210225164639.27212-1-vbabka@suse.cz
Documentation/core-api/printk-formats.rst
lib/vsprintf.c