From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932143AbbBZLNQ (ORCPT ); Thu, 26 Feb 2015 06:13:16 -0500 Received: from xavier.telenet-ops.be ([195.130.132.52]:44859 "EHLO xavier.telenet-ops.be" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753660AbbBZLNJ (ORCPT ); Thu, 26 Feb 2015 06:13:09 -0500 From: Geert Uytterhoeven To: Jonathan Corbet , Andrew Morton , Mike Turquette , Stephen Boyd Cc: Tetsuo Handa , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Geert Uytterhoeven Subject: [PATCH 1/3] lib/vsprintf: Document %p parameters passed by reference Date: Thu, 26 Feb 2015 12:13:01 +0100 Message-Id: <1424949183-31425-2-git-send-email-geert@linux-m68k.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1424949183-31425-1-git-send-email-geert@linux-m68k.org> References: <1424949183-31425-1-git-send-email-geert@linux-m68k.org> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Geert Uytterhoeven Make sure all %p extensions that take parameters by references are documented to do so. Signed-off-by: Geert Uytterhoeven --- This has been sent before as a separate patch, and was updated for the addition of %pT. Documentation/printk-formats.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Documentation/printk-formats.txt b/Documentation/printk-formats.txt index 8858db8f8805bce7..06c8332f0cc09238 100644 --- a/Documentation/printk-formats.txt +++ b/Documentation/printk-formats.txt @@ -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,12 +227,16 @@ dentry names: equivalent of %s dentry->d_name.name we used to use, %pd prints n last components. %pD does the same thing for struct file. + Passed by reference. + task_struct comm name: %pT For printing task_struct->comm. + Passed by reference (NULL for "current"). + struct va_format: %pV @@ -237,6 +252,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); -- 1.9.1