Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7330660e authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Linus Torvalds
Browse files

lib/vsprintf: document %p parameters passed by reference 



This patch series improves the documentation for printk() formats, and
adds support for printing clocks.  The latter has always been a hassle if
you wanted to support both the common and legacy clock frameworks.

  - '%pC' and '%pCn' print the name (Common Clock Framework) or address
    (legacy clock framework) of a clock,
  - '%pCr' prints the current clock rate.

This patch (of 3):

Make sure all %p extensions that take parameters by references are
documented to do so.

Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mike Turquette <mturquette@linaro.org>
Cc: Stephen Boyd <sboyd@codeaurora.org>
Cc: Tetsuo Handa <penguin-kernel@I-love.SAKURA.ne.jp>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent d1c1b121

Documentation/printk-formats.txt

+15 −0
Original line number Diff line number Diff line
@@ -54,6 +54,7 @@ Struct Resources: 


	For printing struct resources. The 'R' and 'r' specifiers result in a

	printed resource with ('R') or without ('r') a decoded flags member.

	Passed by reference.



Physical addresses types phys_addr_t:
@@ -132,6 +133,8 @@ MAC/FDDI addresses: 
	specifier to use reversed byte order suitable for visual interpretation

	of Bluetooth addresses which are in the little endian order.



	Passed by reference.



IPv4 addresses:



	%pI4	1.2.3.4
@@ -146,6 +149,8 @@ IPv4 addresses: 
	host, network, big or little endian order addresses respectively. Where

	no specifier is provided the default network/big endian order is used.



	Passed by reference.



IPv6 addresses:



	%pI6	0001:0002:0003:0004:0005:0006:0007:0008
@@ -160,6 +165,8 @@ IPv6 addresses: 
	print a compressed IPv6 address as described by

	http://tools.ietf.org/html/rfc5952



	Passed by reference.



IPv4/IPv6 addresses (generic, with port, flowinfo, scope):



	%pIS	1.2.3.4		or 0001:0002:0003:0004:0005:0006:0007:0008
@@ -186,6 +193,8 @@ IPv4/IPv6 addresses (generic, with port, flowinfo, scope): 
	specifiers can be used as well and are ignored in case of an IPv6

	address.



	Passed by reference.



	Further examples:



	%pISfc		1.2.3.4		or [1:2:3:4:5:6:7:8]/123456789
@@ -207,6 +216,8 @@ UUID/GUID addresses: 
	Where no additional specifiers are used the default little endian

	order with lower case hex characters will be printed.



	Passed by reference.



dentry names:

	%pd{,2,3,4}

	%pD{,2,3,4}
@@ -216,6 +227,8 @@ dentry names: 
	equivalent of %s dentry->d_name.name we used to use, %pd<n> prints

	n last components.  %pD does the same thing for struct file.



	Passed by reference.



struct va_format:



	%pV
@@ -231,6 +244,8 @@ struct va_format: 
	Do not use this feature without some mechanism to verify the

	correctness of the format string and va_list arguments.



	Passed by reference.



u64 SHOULD be printed with %llu/%llx:



	printk("%llu", u64_var);