From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752657AbbJBMr1 (ORCPT ); Fri, 2 Oct 2015 08:47:27 -0400 Received: from mga11.intel.com ([192.55.52.93]:1860 "EHLO mga11.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752627AbbJBMrZ (ORCPT ); Fri, 2 Oct 2015 08:47:25 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.17,623,1437462000"; d="scan'208";a="817921656" Message-ID: <1443790039.8361.334.camel@linux.intel.com> Subject: Re: [PATCH] lib/vsprintf.c: update documentation From: Andy Shevchenko To: Rasmus Villemoes , Andrew Morton , Jonathan Corbet Cc: Martin Kletzander , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Date: Fri, 02 Oct 2015 15:47:19 +0300 In-Reply-To: <1443788886-4948-1-git-send-email-linux@rasmusvillemoes.dk> References: <1443788886-4948-1-git-send-email-linux@rasmusvillemoes.dk> Organization: Intel Finland Oy Content-Type: text/plain; charset="UTF-8" X-Mailer: Evolution 3.16.3-1 Mime-Version: 1.0 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, 2015-10-02 at 14:28 +0200, Rasmus Villemoes wrote: > %n is no longer just ignored; it results in early return from > vsnprintf. Also add a request to add test cases for future %p > extensions. Nice! Reviewed-by: Andy Shevchenko > > Signed-off-by: Rasmus Villemoes > --- > applies on top of > lib-documentation-synchronize-%p-formatting-documentation.patch and > its -fix. > > Documentation/printk-formats.txt | 12 ++++++------ > lib/vsprintf.c | 7 ++++--- > 2 files changed, 10 insertions(+), 9 deletions(-) > > diff --git a/Documentation/printk-formats.txt b/Documentation/printk > -formats.txt > index 9b8d7f746b1a..b784c270105f 100644 > --- a/Documentation/printk-formats.txt > +++ b/Documentation/printk-formats.txt > @@ -23,6 +23,10 @@ Example: > > Reminder: sizeof() result is of type size_t. > > +The kernel's printf does not support %n. For obvious reasons, > floating > +point formats (%e, %f, %g, %a) are also not recognized. Use of any > +unsupported specifier or length qualifier results in a WARN and > early > +return from vsnprintf. > > Raw pointer value SHOULD be printed with %p. The kernel supports > the following extended format specifiers for pointer types: > @@ -305,13 +309,9 @@ Command from struct task_struct > > Passed by reference. > > -Ignored argument: > +If you add other %p extensions, please extend lib/test_printf.c with > +one or more test cases, if at all feasible. > > - %n %n > - > - The argument passed will be ignored. In other words, > literal "%n" will > - be in the output and the argument will be considered for > next format > - specifier. > > Thank you for your cooperation and attention. > > diff --git a/lib/vsprintf.c b/lib/vsprintf.c > index 5028b044d0e5..488ee489279a 100644 > --- a/lib/vsprintf.c > +++ b/lib/vsprintf.c > @@ -1448,7 +1448,6 @@ int kptr_restrict __read_mostly; > * - 'Cn' For a clock, it prints the name (Common Clock Framework) > or address > * (legacy clock framework) of the clock > * - 'Cr' For a clock, it prints the current rate of the clock > - * - 'n' For ignored argument > * > * ** Please update also Documentation/printk-formats.txt when > making changes ** > * > @@ -1814,8 +1813,10 @@ qualifier: > * @fmt: The format string to use > * @args: Arguments for the format string > * > - * This function follows C99 vsnprintf, but has some extensions: > - * %n is ignored > + * This function generally follows C99 vsnprintf, but has some > + * extensions and a few limitations: > + * > + * %n is unsupported > * %p* is handled by pointer() > * > * See pointer() or Documentation/printk-formats.txt for more -- Andy Shevchenko Intel Finland Oy