Documentation/printf: struct resource add start == end special case
authorIra Weiny <ira.weiny@intel.com>
Sat, 26 Oct 2024 00:46:54 +0000 (19:46 -0500)
committerDave Jiang <dave.jiang@intel.com>
Mon, 28 Oct 2024 21:30:52 +0000 (14:30 -0700)
The code when printing a struct resource will check for start == end and
only print the start value.

Document this special case.

Suggested-by: Petr Mladek <pmladek@suse.com>
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://patch.msgid.link/20241025-cxl-pra-v2-2-123a825daba2@intel.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
Documentation/core-api/printk-formats.rst

index 14e093d..552f510 100644 (file)
@@ -209,12 +209,17 @@ Struct Resources
 ::
 
        %pr     [mem 0x60000000-0x6fffffff flags 0x2200] or
+               [mem 0x60000000 flags 0x2200] or
                [mem 0x0000000060000000-0x000000006fffffff flags 0x2200]
+               [mem 0x0000000060000000 flags 0x2200]
        %pR     [mem 0x60000000-0x6fffffff pref] or
+               [mem 0x60000000 pref] or
                [mem 0x0000000060000000-0x000000006fffffff pref]
+               [mem 0x0000000060000000 pref]
 
 For printing struct resources. The ``R`` and ``r`` specifiers result in a
-printed resource with (R) or without (r) a decoded flags member.
+printed resource with (R) or without (r) a decoded flags member.  If start is
+equal to end only print the start value.
 
 Passed by reference.