Commit 94ac8f20 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Jonathan Corbet
Browse files

doc: printk-formats: Remove bogus kobject references for device nodes 



When converting from text to rst, the kobjects section and its sole
subsection about device tree nodes were coalesced into a single section,
yielding an inconsistent result.

Remove all references to kobjects, as
  1. Device tree object pointers are not compatible to kobject pointers
     (the former may embed the latter, though), and
  2. there are no printk formats defined for kobject types.

Update the vsprintf() source code comments to match the above.

Fixes: b3ed2321 ("doc: convert printk-formats.txt to rst")
Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 44280690

Documentation/core-api/printk-formats.rst

+3 −3
Original line number Diff line number Diff line
@@ -376,15 +376,15 @@ correctness of the format string and va_list arguments. 


Passed by reference.



kobjects

--------

Device tree nodes

-----------------



::



	%pOF[fnpPcCF]





For printing kobject based structs (device nodes). Default behaviour is

For printing device tree node structures. Default behaviour is

equivalent to %pOFf.



	- f - device node full_name

lib/vsprintf.c

+9 −11
Original line number Diff line number Diff line
@@ -1833,7 +1833,6 @@ static char *ptr_to_id(char *buf, char *end, void *ptr, struct printf_spec spec) 
 *       p page flags (see struct page) given as pointer to unsigned long

 *       g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t

 *       v vma flags (VM_*) given as pointer to unsigned long

 * - 'O' For a kobject based struct. Must be one of the following:

 * - 'OF[fnpPcCF]'  For a device tree object

 *                  Without any optional arguments prints the full_name

 *                  f device node full_name
@@ -1843,7 +1842,6 @@ static char *ptr_to_id(char *buf, char *end, void *ptr, struct printf_spec spec) 
 *                  F device node flags

 *                  c major compatible string

 *                  C full compatible string

 *

 * - 'x' For printing the address. Equivalent to "%lx".

 *

 * ** When making changes please also update:

CRA Git | Maintained and supported by SUSTech CRA and CCSE