Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1231933 > unrolled thread

[PATCH v2] lib: Documentation: Synchronize %p formatting documentation

Started byMartin Kletzander <mkletzan@redhat.com>
First post2015-09-24 10:10 +0200
Last post2015-09-24 14:40 +0200
Articles 4 — 3 participants

Back to article view | Back to linux.kernel

Contents

  [PATCH v2] lib: Documentation: Synchronize %p formatting documentation Martin Kletzander <mkletzan@redhat.com> - 2015-09-24 10:10 +0200
    Re: [PATCH v2] lib: Documentation: Synchronize %p formatting  documentation Andy Shevchenko <andriy.shevchenko@linux.intel.com> - 2015-09-24 10:20 +0200
      Re: [PATCH v2] lib: Documentation: Synchronize %p formatting  documentation "Shevchenko, Andriy" <andriy.shevchenko@intel.com> - 2015-09-24 10:30 +0200
        Re: [PATCH v2] lib: Documentation: Synchronize %p formatting  documentation Martin Kletzander <mkletzan@redhat.com> - 2015-09-24 14:40 +0200

#1231933 — [PATCH v2] lib: Documentation: Synchronize %p formatting documentation

FromMartin Kletzander <mkletzan@redhat.com>
Date2015-09-24 10:10 +0200
Subject[PATCH v2] lib: Documentation: Synchronize %p formatting documentation
Message-ID<qc9Lk-5Dv-11@gated-at.bofh.it>
Move all pointer-formatting documentation to one place in the code and
one place in the documentation instead of keeping it in three places
with different level of completeness.  Documentation/printk-formats.txt
has detailed information about each modifier, docstring above pointer()
has short descriptions of them (as that is the function dealing with %p)
and docstring above vsprintf() is removed as redundant.  Both docstrings
in the code that were modified are updated with a reminder of updating
the documentation upon any further change.

Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
---
 Documentation/printk-formats.txt | 27 +++++++++++++++++++++++++
 lib/vsprintf.c                   | 43 ++++++++--------------------------------
 2 files changed, 35 insertions(+), 35 deletions(-)

diff --git a/Documentation/printk-formats.txt b/Documentation/printk-formats.txt
index 2ec6d84f391c..c85e27264a2b 100644
--- a/Documentation/printk-formats.txt
+++ b/Documentation/printk-formats.txt
@@ -119,6 +119,7 @@ Raw buffer as an escaped string:
 	If field width is omitted the 1 byte only will be escaped.

 Raw buffer as a hex string:
+
 	%*ph	00 01 02  ...  3f
 	%*phC	00:01:02: ... :3f
 	%*phD	00-01-02- ... -3f
@@ -234,6 +235,7 @@ UUID/GUID addresses:
 	Passed by reference.

 dentry names:
+
 	%pd{,2,3,4}
 	%pD{,2,3,4}

@@ -264,6 +266,8 @@ struct va_format:
 		va_list *va;
 	};

+	Implements a "recursive vsnprintf".
+
 	Do not use this feature without some mechanism to verify the
 	correctness of the format string and va_list arguments.

@@ -292,6 +296,29 @@ bitmap and its derivatives such as cpumask and nodemask:

 	Passed by reference.

+Network device features:
+
+	%pNF	0x000000000000c000
+
+	For printing netdev_features_t.
+
+	Passed by reference.
+
+Command from struct task_struct
+
+	%pT	ls
+
+	For printing executable name excluding path from struct
+	task_struct.
+
+	Passed by reference.
+
+Ignored argument:
+
+	%pn
+
+	The argument passed will be ignored.
+
 Thank you for your cooperation and attention.


diff --git a/lib/vsprintf.c b/lib/vsprintf.c
index becd87facf48..9ab68775b840 100644
--- a/lib/vsprintf.c
+++ b/lib/vsprintf.c
@@ -1463,7 +1463,10 @@ 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
- * - 'T' task_struct->comm
+ * - 'T' For task_struct->comm
+ * - 'n' For ignored argument
+ *
+ * ** Please update Documentation/printk-formats.txt when making changes **
  *
  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
  * function pointers are really function descriptors, which contain a
@@ -1829,41 +1832,11 @@ qualifier:
  * @fmt: The format string to use
  * @args: Arguments for the format string
  *
- * This function follows C99 vsnprintf, but has some extensions:
- * %pS output the name of a text symbol with offset
- * %ps output the name of a text symbol without offset
- * %pF output the name of a function pointer with its offset
- * %pf output the name of a function pointer without its offset
- * %pB output the name of a backtrace symbol with its offset
- * %pR output the address range in a struct resource with decoded flags
- * %pr output the address range in a struct resource with raw flags
- * %pb output the bitmap with field width as the number of bits
- * %pbl output the bitmap as range list with field width as the number of bits
- * %pM output a 6-byte MAC address with colons
- * %pMR output a 6-byte MAC address with colons in reversed order
- * %pMF output a 6-byte MAC address with dashes
- * %pm output a 6-byte MAC address without colons
- * %pmR output a 6-byte MAC address without colons in reversed order
- * %pI4 print an IPv4 address without leading zeros
- * %pi4 print an IPv4 address with leading zeros
- * %pI6 print an IPv6 address with colons
- * %pi6 print an IPv6 address without colons
- * %pI6c print an IPv6 address as specified by RFC 5952
- * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
- * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
- * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
- *   case.
- * %*pE[achnops] print an escaped buffer
- * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
- *           bytes of the input)
- * %pC output the name (Common Clock Framework) or address (legacy clock
- *     framework) of a clock
- * %pCn output the name (Common Clock Framework) or address (legacy clock
- *      framework) of a clock
- * %pCr output the current rate of a clock
- * %n is ignored
+ * This function follows C99 vsnprintf, but has some extensions.  See
+ * pointer() or Documentation/printk-formats.txt for all format
+ * specifiers.
  *
- * ** Please update Documentation/printk-formats.txt when making changes **
+ * ** Please update the documentation when making changes **
  *
  * The return value is the number of characters which would
  * be generated for the given input, excluding the trailing
-- 
2.5.3

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [next] | [standalone]

#1231940 — Re: [PATCH v2] lib: Documentation: Synchronize %p formatting documentation

FromAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Date2015-09-24 10:20 +0200
SubjectRe: [PATCH v2] lib: Documentation: Synchronize %p formatting documentation
Message-ID<qc9V0-5OU-19@gated-at.bofh.it>
In reply to#1231933
On Thu, 2015-09-24 at 10:08 +0200, Martin Kletzander wrote:
> Move all pointer-formatting documentation to one place in the code 
> and
> one place in the documentation instead of keeping it in three places
> with different level of completeness.  Documentation/printk
> -formats.txt
> has detailed information about each modifier, docstring above 
> pointer()
> has short descriptions of them (as that is the function dealing with 
> %p)
> and docstring above vsprintf() is removed as redundant.  Both 
> docstrings
> in the code that were modified are updated with a reminder of 
> updating
> the documentation upon any further change.
> 

Good for me!

Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

> Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
> ---
>  Documentation/printk-formats.txt | 27 +++++++++++++++++++++++++
>  lib/vsprintf.c                   | 43 ++++++++----------------------
> ----------
>  2 files changed, 35 insertions(+), 35 deletions(-)
> 
> diff --git a/Documentation/printk-formats.txt b/Documentation/printk
> -formats.txt
> index 2ec6d84f391c..c85e27264a2b 100644
> --- a/Documentation/printk-formats.txt
> +++ b/Documentation/printk-formats.txt
> @@ -119,6 +119,7 @@ Raw buffer as an escaped string:
>  	If field width is omitted the 1 byte only will be escaped.
> 
>  Raw buffer as a hex string:
> +
>  	%*ph	00 01 02  ...  3f
>  	%*phC	00:01:02: ... :3f
>  	%*phD	00-01-02- ... -3f
> @@ -234,6 +235,7 @@ UUID/GUID addresses:
>  	Passed by reference.
> 
>  dentry names:
> +
>  	%pd{,2,3,4}
>  	%pD{,2,3,4}
> 
> @@ -264,6 +266,8 @@ struct va_format:
>  		va_list *va;
>  	};
> 
> +	Implements a "recursive vsnprintf".
> +
>  	Do not use this feature without some mechanism to verify the
>  	correctness of the format string and va_list arguments.
> 
> @@ -292,6 +296,29 @@ bitmap and its derivatives such as cpumask and 
> nodemask:
> 
>  	Passed by reference.
> 
> +Network device features:
> +
> +	%pNF	0x000000000000c000
> +
> +	For printing netdev_features_t.
> +
> +	Passed by reference.
> +
> +Command from struct task_struct
> +
> +	%pT	ls
> +
> +	For printing executable name excluding path from struct
> +	task_struct.
> +
> +	Passed by reference.
> +
> +Ignored argument:
> +
> +	%pn
> +
> +	The argument passed will be ignored.
> +
>  Thank you for your cooperation and attention.
> 
> 
> diff --git a/lib/vsprintf.c b/lib/vsprintf.c
> index becd87facf48..9ab68775b840 100644
> --- a/lib/vsprintf.c
> +++ b/lib/vsprintf.c
> @@ -1463,7 +1463,10 @@ 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
> - * - 'T' task_struct->comm
> + * - 'T' For task_struct->comm
> + * - 'n' For ignored argument
> + *
> + * ** Please update Documentation/printk-formats.txt when making 
> changes **
>   *
>   * Note: The difference between 'S' and 'F' is that on ia64 and 
> ppc64
>   * function pointers are really function descriptors, which contain 
> a
> @@ -1829,41 +1832,11 @@ qualifier:
>   * @fmt: The format string to use
>   * @args: Arguments for the format string
>   *
> - * This function follows C99 vsnprintf, but has some extensions:
> - * %pS output the name of a text symbol with offset
> - * %ps output the name of a text symbol without offset
> - * %pF output the name of a function pointer with its offset
> - * %pf output the name of a function pointer without its offset
> - * %pB output the name of a backtrace symbol with its offset
> - * %pR output the address range in a struct resource with decoded 
> flags
> - * %pr output the address range in a struct resource with raw flags
> - * %pb output the bitmap with field width as the number of bits
> - * %pbl output the bitmap as range list with field width as the 
> number of bits
> - * %pM output a 6-byte MAC address with colons
> - * %pMR output a 6-byte MAC address with colons in reversed order
> - * %pMF output a 6-byte MAC address with dashes
> - * %pm output a 6-byte MAC address without colons
> - * %pmR output a 6-byte MAC address without colons in reversed order
> - * %pI4 print an IPv4 address without leading zeros
> - * %pi4 print an IPv4 address with leading zeros
> - * %pI6 print an IPv6 address with colons
> - * %pi6 print an IPv6 address without colons
> - * %pI6c print an IPv6 address as specified by RFC 5952
> - * %pIS depending on sa_family of 'struct sockaddr *' print 
> IPv4/IPv6 address
> - * %piS depending on sa_family of 'struct sockaddr *' print 
> IPv4/IPv6 address
> - * %pU[bBlL] print a UUID/GUID in big or little endian using lower 
> or upper
> - *   case.
> - * %*pE[achnops] print an escaped buffer
> - * %*ph[CDN] a variable-length hex string with a separator (supports 
> up to 64
> - *           bytes of the input)
> - * %pC output the name (Common Clock Framework) or address (legacy 
> clock
> - *     framework) of a clock
> - * %pCn output the name (Common Clock Framework) or address (legacy 
> clock
> - *      framework) of a clock
> - * %pCr output the current rate of a clock
> - * %n is ignored
> + * This function follows C99 vsnprintf, but has some extensions. 
>  See
> + * pointer() or Documentation/printk-formats.txt for all format
> + * specifiers.
>   *
> - * ** Please update Documentation/printk-formats.txt when making 
> changes **
> + * ** Please update the documentation when making changes **
>   *
>   * The return value is the number of characters which would
>   * be generated for the given input, excluding the trailing

-- 
Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Intel Finland Oy
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [next] | [standalone]

#1231945 — Re: [PATCH v2] lib: Documentation: Synchronize %p formatting documentation

From"Shevchenko, Andriy" <andriy.shevchenko@intel.com>
Date2015-09-24 10:30 +0200
SubjectRe: [PATCH v2] lib: Documentation: Synchronize %p formatting documentation
Message-ID<qca4G-60q-25@gated-at.bofh.it>
In reply to#1231940
T24gVGh1LCAyMDE1LTA5LTI0IGF0IDExOjE2ICswMzAwLCBBbmR5IFNoZXZjaGVua28gd3JvdGU6
DQo+IE9uIFRodSwgMjAxNS0wOS0yNCBhdCAxMDowOCArMDIwMCwgTWFydGluIEtsZXR6YW5kZXIg
d3JvdGU6DQo+ID4gTW92ZSBhbGwgcG9pbnRlci1mb3JtYXR0aW5nIGRvY3VtZW50YXRpb24gdG8g
b25lIHBsYWNlIGluIHRoZSBjb2RlIA0KPiA+IGFuZA0KPiA+IG9uZSBwbGFjZSBpbiB0aGUgZG9j
dW1lbnRhdGlvbiBpbnN0ZWFkIG9mIGtlZXBpbmcgaXQgaW4gdGhyZWUgDQo+ID4gcGxhY2VzDQo+
ID4gd2l0aCBkaWZmZXJlbnQgbGV2ZWwgb2YgY29tcGxldGVuZXNzLiAgRG9jdW1lbnRhdGlvbi9w
cmludGsNCj4gPiAtZm9ybWF0cy50eHQNCj4gPiBoYXMgZGV0YWlsZWQgaW5mb3JtYXRpb24gYWJv
dXQgZWFjaCBtb2RpZmllciwgZG9jc3RyaW5nIGFib3ZlIA0KPiA+IHBvaW50ZXIoKQ0KPiA+IGhh
cyBzaG9ydCBkZXNjcmlwdGlvbnMgb2YgdGhlbSAoYXMgdGhhdCBpcyB0aGUgZnVuY3Rpb24gZGVh
bGluZyANCj4gPiB3aXRoIA0KPiA+ICVwKQ0KPiA+IGFuZCBkb2NzdHJpbmcgYWJvdmUgdnNwcmlu
dGYoKSBpcyByZW1vdmVkIGFzIHJlZHVuZGFudC4gIEJvdGggDQo+ID4gZG9jc3RyaW5ncw0KPiA+
IGluIHRoZSBjb2RlIHRoYXQgd2VyZSBtb2RpZmllZCBhcmUgdXBkYXRlZCB3aXRoIGEgcmVtaW5k
ZXIgb2YgDQo+ID4gdXBkYXRpbmcNCj4gPiB0aGUgZG9jdW1lbnRhdGlvbiB1cG9uIGFueSBmdXJ0
aGVyIGNoYW5nZS4NCj4gPiANCj4gDQo+IEdvb2QgZm9yIG1lIQ0KPiANCj4gUmV2aWV3ZWQtYnk6
IEFuZHkgU2hldmNoZW5rbyA8YW5kcml5LnNoZXZjaGVua29AbGludXguaW50ZWwuY29tPg0KPiAN
Cg0KQWgsIHNvcnJ5LCBpdCBzZWVtcyB5b3UgaGF2ZSB0byBkaXN0aW5ndWlzaCAlcG4gKHdoaWNo
IHNlZW1zIG5vdyBhcyAlcA0KKyBuIGlmIEkgZGlkbid0IG1pc3MgYW55dGhpbmcpIGFuZCAlbi4N
Cg0KQWZ0ZXIgYWRkcmVzc2luZyB0aGlzLCB0YWtlIG15IGFib3ZlIHRhZy4NCg0KPiA+IFNpZ25l
ZC1vZmYtYnk6IE1hcnRpbiBLbGV0emFuZGVyIDxta2xldHphbkByZWRoYXQuY29tPg0KPiA+IC0t
LQ0KPiA+ICBEb2N1bWVudGF0aW9uL3ByaW50ay1mb3JtYXRzLnR4dCB8IDI3ICsrKysrKysrKysr
KysrKysrKysrKysrKysNCj4gPiAgbGliL3ZzcHJpbnRmLmMgICAgICAgICAgICAgICAgICAgfCA0
MyArKysrKysrKy0tLS0tLS0tLS0tLS0tLS0tLS0tDQo+ID4gLS0NCj4gPiAtLS0tLS0tLS0tDQo+
ID4gIDIgZmlsZXMgY2hhbmdlZCwgMzUgaW5zZXJ0aW9ucygrKSwgMzUgZGVsZXRpb25zKC0pDQo+
ID4gDQo+ID4gZGlmZiAtLWdpdCBhL0RvY3VtZW50YXRpb24vcHJpbnRrLWZvcm1hdHMudHh0IA0K
PiA+IGIvRG9jdW1lbnRhdGlvbi9wcmludGsNCj4gPiAtZm9ybWF0cy50eHQNCj4gPiBpbmRleCAy
ZWM2ZDg0ZjM5MWMuLmM4NWUyNzI2NGEyYiAxMDA2NDQNCj4gPiAtLS0gYS9Eb2N1bWVudGF0aW9u
L3ByaW50ay1mb3JtYXRzLnR4dA0KPiA+ICsrKyBiL0RvY3VtZW50YXRpb24vcHJpbnRrLWZvcm1h
dHMudHh0DQo+ID4gQEAgLTExOSw2ICsxMTksNyBAQCBSYXcgYnVmZmVyIGFzIGFuIGVzY2FwZWQg
c3RyaW5nOg0KPiA+ICAJSWYgZmllbGQgd2lkdGggaXMgb21pdHRlZCB0aGUgMSBieXRlIG9ubHkg
d2lsbCBiZSBlc2NhcGVkLg0KPiA+IA0KPiA+ICBSYXcgYnVmZmVyIGFzIGEgaGV4IHN0cmluZzoN
Cj4gPiArDQo+ID4gIAklKnBoCTAwIDAxIDAyICAuLi4gIDNmDQo+ID4gIAklKnBoQwkwMDowMTow
MjogLi4uIDozZg0KPiA+ICAJJSpwaEQJMDAtMDEtMDItIC4uLiAtM2YNCj4gPiBAQCAtMjM0LDYg
KzIzNSw3IEBAIFVVSUQvR1VJRCBhZGRyZXNzZXM6DQo+ID4gIAlQYXNzZWQgYnkgcmVmZXJlbmNl
Lg0KPiA+IA0KPiA+ICBkZW50cnkgbmFtZXM6DQo+ID4gKw0KPiA+ICAJJXBkeywyLDMsNH0NCj4g
PiAgCSVwRHssMiwzLDR9DQo+ID4gDQo+ID4gQEAgLTI2NCw2ICsyNjYsOCBAQCBzdHJ1Y3QgdmFf
Zm9ybWF0Og0KPiA+ICAJCXZhX2xpc3QgKnZhOw0KPiA+ICAJfTsNCj4gPiANCj4gPiArCUltcGxl
bWVudHMgYSAicmVjdXJzaXZlIHZzbnByaW50ZiIuDQo+ID4gKw0KPiA+ICAJRG8gbm90IHVzZSB0
aGlzIGZlYXR1cmUgd2l0aG91dCBzb21lIG1lY2hhbmlzbSB0byB2ZXJpZnkgDQo+ID4gdGhlDQo+
ID4gIAljb3JyZWN0bmVzcyBvZiB0aGUgZm9ybWF0IHN0cmluZyBhbmQgdmFfbGlzdCBhcmd1bWVu
dHMuDQo+ID4gDQo+ID4gQEAgLTI5Miw2ICsyOTYsMjkgQEAgYml0bWFwIGFuZCBpdHMgZGVyaXZh
dGl2ZXMgc3VjaCBhcyBjcHVtYXNrIGFuZCANCj4gPiANCj4gPiBub2RlbWFzazoNCj4gPiANCj4g
PiAgCVBhc3NlZCBieSByZWZlcmVuY2UuDQo+ID4gDQo+ID4gK05ldHdvcmsgZGV2aWNlIGZlYXR1
cmVzOg0KPiA+ICsNCj4gPiArCSVwTkYJMHgwMDAwMDAwMDAwMDBjMDAwDQo+ID4gKw0KPiA+ICsJ
Rm9yIHByaW50aW5nIG5ldGRldl9mZWF0dXJlc190Lg0KPiA+ICsNCj4gPiArCVBhc3NlZCBieSBy
ZWZlcmVuY2UuDQo+ID4gKw0KPiA+ICtDb21tYW5kIGZyb20gc3RydWN0IHRhc2tfc3RydWN0DQo+
ID4gKw0KPiA+ICsJJXBUCWxzDQo+ID4gKw0KPiA+ICsJRm9yIHByaW50aW5nIGV4ZWN1dGFibGUg
bmFtZSBleGNsdWRpbmcgcGF0aCBmcm9tIHN0cnVjdA0KPiA+ICsJdGFza19zdHJ1Y3QuDQo+ID4g
Kw0KPiA+ICsJUGFzc2VkIGJ5IHJlZmVyZW5jZS4NCj4gPiArDQo+ID4gK0lnbm9yZWQgYXJndW1l
bnQ6DQo+ID4gKw0KPiA+ICsJJXBuDQo+ID4gKw0KPiA+ICsJVGhlIGFyZ3VtZW50IHBhc3NlZCB3
aWxsIGJlIGlnbm9yZWQuDQo+ID4gKw0KPiA+ICBUaGFuayB5b3UgZm9yIHlvdXIgY29vcGVyYXRp
b24gYW5kIGF0dGVudGlvbi4NCj4gPiANCj4gPiANCj4gPiBkaWZmIC0tZ2l0IGEvbGliL3ZzcHJp
bnRmLmMgYi9saWIvdnNwcmludGYuYw0KPiA+IGluZGV4IGJlY2Q4N2ZhY2Y0OC4uOWFiNjg3NzVi
ODQwIDEwMDY0NA0KPiA+IC0tLSBhL2xpYi92c3ByaW50Zi5jDQo+ID4gKysrIGIvbGliL3ZzcHJp
bnRmLmMNCj4gPiBAQCAtMTQ2Myw3ICsxNDYzLDEwIEBAIGludCBrcHRyX3Jlc3RyaWN0IF9fcmVh
ZF9tb3N0bHk7DQo+ID4gICAqIC0gJ0NuJyBGb3IgYSBjbG9jaywgaXQgcHJpbnRzIHRoZSBuYW1l
IChDb21tb24gQ2xvY2sgRnJhbWV3b3JrKSANCj4gPiANCj4gPiBvciBhZGRyZXNzDQo+ID4gICAq
ICAgICAgICAobGVnYWN5IGNsb2NrIGZyYW1ld29yaykgb2YgdGhlIGNsb2NrDQo+ID4gICAqIC0g
J0NyJyBGb3IgYSBjbG9jaywgaXQgcHJpbnRzIHRoZSBjdXJyZW50IHJhdGUgb2YgdGhlIGNsb2Nr
DQo+ID4gLSAqIC0gJ1QnIHRhc2tfc3RydWN0LT5jb21tDQo+ID4gKyAqIC0gJ1QnIEZvciB0YXNr
X3N0cnVjdC0+Y29tbQ0KPiA+ICsgKiAtICduJyBGb3IgaWdub3JlZCBhcmd1bWVudA0KPiA+ICsg
Kg0KPiA+ICsgKiAqKiBQbGVhc2UgdXBkYXRlIERvY3VtZW50YXRpb24vcHJpbnRrLWZvcm1hdHMu
dHh0IHdoZW4gbWFraW5nIA0KPiA+IGNoYW5nZXMgKioNCj4gPiAgICoNCj4gPiAgICogTm90ZTog
VGhlIGRpZmZlcmVuY2UgYmV0d2VlbiAnUycgYW5kICdGJyBpcyB0aGF0IG9uIGlhNjQgYW5kIA0K
PiA+IHBwYzY0DQo+ID4gICAqIGZ1bmN0aW9uIHBvaW50ZXJzIGFyZSByZWFsbHkgZnVuY3Rpb24g
ZGVzY3JpcHRvcnMsIHdoaWNoIA0KPiA+IGNvbnRhaW4gDQo+ID4gYQ0KPiA+IEBAIC0xODI5LDQx
ICsxODMyLDExIEBAIHF1YWxpZmllcjoNCj4gPiAgICogQGZtdDogVGhlIGZvcm1hdCBzdHJpbmcg
dG8gdXNlDQo+ID4gICAqIEBhcmdzOiBBcmd1bWVudHMgZm9yIHRoZSBmb3JtYXQgc3RyaW5nDQo+
ID4gICAqDQo+ID4gLSAqIFRoaXMgZnVuY3Rpb24gZm9sbG93cyBDOTkgdnNucHJpbnRmLCBidXQg
aGFzIHNvbWUgZXh0ZW5zaW9uczoNCj4gPiAtICogJXBTIG91dHB1dCB0aGUgbmFtZSBvZiBhIHRl
eHQgc3ltYm9sIHdpdGggb2Zmc2V0DQo+ID4gLSAqICVwcyBvdXRwdXQgdGhlIG5hbWUgb2YgYSB0
ZXh0IHN5bWJvbCB3aXRob3V0IG9mZnNldA0KPiA+IC0gKiAlcEYgb3V0cHV0IHRoZSBuYW1lIG9m
IGEgZnVuY3Rpb24gcG9pbnRlciB3aXRoIGl0cyBvZmZzZXQNCj4gPiAtICogJXBmIG91dHB1dCB0
aGUgbmFtZSBvZiBhIGZ1bmN0aW9uIHBvaW50ZXIgd2l0aG91dCBpdHMgb2Zmc2V0DQo+ID4gLSAq
ICVwQiBvdXRwdXQgdGhlIG5hbWUgb2YgYSBiYWNrdHJhY2Ugc3ltYm9sIHdpdGggaXRzIG9mZnNl
dA0KPiA+IC0gKiAlcFIgb3V0cHV0IHRoZSBhZGRyZXNzIHJhbmdlIGluIGEgc3RydWN0IHJlc291
cmNlIHdpdGggZGVjb2RlZCANCj4gPiBmbGFncw0KPiA+IC0gKiAlcHIgb3V0cHV0IHRoZSBhZGRy
ZXNzIHJhbmdlIGluIGEgc3RydWN0IHJlc291cmNlIHdpdGggcmF3IA0KPiA+IGZsYWdzDQo+ID4g
LSAqICVwYiBvdXRwdXQgdGhlIGJpdG1hcCB3aXRoIGZpZWxkIHdpZHRoIGFzIHRoZSBudW1iZXIg
b2YgYml0cw0KPiA+IC0gKiAlcGJsIG91dHB1dCB0aGUgYml0bWFwIGFzIHJhbmdlIGxpc3Qgd2l0
aCBmaWVsZCB3aWR0aCBhcyB0aGUgDQo+ID4gbnVtYmVyIG9mIGJpdHMNCj4gPiAtICogJXBNIG91
dHB1dCBhIDYtYnl0ZSBNQUMgYWRkcmVzcyB3aXRoIGNvbG9ucw0KPiA+IC0gKiAlcE1SIG91dHB1
dCBhIDYtYnl0ZSBNQUMgYWRkcmVzcyB3aXRoIGNvbG9ucyBpbiByZXZlcnNlZCBvcmRlcg0KPiA+
IC0gKiAlcE1GIG91dHB1dCBhIDYtYnl0ZSBNQUMgYWRkcmVzcyB3aXRoIGRhc2hlcw0KPiA+IC0g
KiAlcG0gb3V0cHV0IGEgNi1ieXRlIE1BQyBhZGRyZXNzIHdpdGhvdXQgY29sb25zDQo+ID4gLSAq
ICVwbVIgb3V0cHV0IGEgNi1ieXRlIE1BQyBhZGRyZXNzIHdpdGhvdXQgY29sb25zIGluIHJldmVy
c2VkIA0KPiA+IG9yZGVyDQo+ID4gLSAqICVwSTQgcHJpbnQgYW4gSVB2NCBhZGRyZXNzIHdpdGhv
dXQgbGVhZGluZyB6ZXJvcw0KPiA+IC0gKiAlcGk0IHByaW50IGFuIElQdjQgYWRkcmVzcyB3aXRo
IGxlYWRpbmcgemVyb3MNCj4gPiAtICogJXBJNiBwcmludCBhbiBJUHY2IGFkZHJlc3Mgd2l0aCBj
b2xvbnMNCj4gPiAtICogJXBpNiBwcmludCBhbiBJUHY2IGFkZHJlc3Mgd2l0aG91dCBjb2xvbnMN
Cj4gPiAtICogJXBJNmMgcHJpbnQgYW4gSVB2NiBhZGRyZXNzIGFzIHNwZWNpZmllZCBieSBSRkMg
NTk1Mg0KPiA+IC0gKiAlcElTIGRlcGVuZGluZyBvbiBzYV9mYW1pbHkgb2YgJ3N0cnVjdCBzb2Nr
YWRkciAqJyBwcmludCANCj4gPiBJUHY0L0lQdjYgYWRkcmVzcw0KPiA+IC0gKiAlcGlTIGRlcGVu
ZGluZyBvbiBzYV9mYW1pbHkgb2YgJ3N0cnVjdCBzb2NrYWRkciAqJyBwcmludCANCj4gPiBJUHY0
L0lQdjYgYWRkcmVzcw0KPiA+IC0gKiAlcFVbYkJsTF0gcHJpbnQgYSBVVUlEL0dVSUQgaW4gYmln
IG9yIGxpdHRsZSBlbmRpYW4gdXNpbmcgbG93ZXIgDQo+ID4gDQo+ID4gb3IgdXBwZXINCj4gPiAt
ICogICBjYXNlLg0KPiA+IC0gKiAlKnBFW2FjaG5vcHNdIHByaW50IGFuIGVzY2FwZWQgYnVmZmVy
DQo+ID4gLSAqICUqcGhbQ0ROXSBhIHZhcmlhYmxlLWxlbmd0aCBoZXggc3RyaW5nIHdpdGggYSBz
ZXBhcmF0b3IgDQo+ID4gKHN1cHBvcnRzIA0KPiA+IHVwIHRvIDY0DQo+ID4gLSAqICAgICAgICAg
ICBieXRlcyBvZiB0aGUgaW5wdXQpDQo+ID4gLSAqICVwQyBvdXRwdXQgdGhlIG5hbWUgKENvbW1v
biBDbG9jayBGcmFtZXdvcmspIG9yIGFkZHJlc3MgKGxlZ2FjeSANCj4gPiANCj4gPiBjbG9jaw0K
PiA+IC0gKiAgICAgZnJhbWV3b3JrKSBvZiBhIGNsb2NrDQo+ID4gLSAqICVwQ24gb3V0cHV0IHRo
ZSBuYW1lIChDb21tb24gQ2xvY2sgRnJhbWV3b3JrKSBvciBhZGRyZXNzIA0KPiA+IChsZWdhY3kg
DQo+ID4gY2xvY2sNCj4gPiAtICogICAgICBmcmFtZXdvcmspIG9mIGEgY2xvY2sNCj4gPiAtICog
JXBDciBvdXRwdXQgdGhlIGN1cnJlbnQgcmF0ZSBvZiBhIGNsb2NrDQo+ID4gLSAqICVuIGlzIGln
bm9yZWQNCj4gPiArICogVGhpcyBmdW5jdGlvbiBmb2xsb3dzIEM5OSB2c25wcmludGYsIGJ1dCBo
YXMgc29tZSBleHRlbnNpb25zLiANCj4gPiAgU2VlDQo+ID4gKyAqIHBvaW50ZXIoKSBvciBEb2N1
bWVudGF0aW9uL3ByaW50ay1mb3JtYXRzLnR4dCBmb3IgYWxsIGZvcm1hdA0KPiA+ICsgKiBzcGVj
aWZpZXJzLg0KPiA+ICAgKg0KPiA+IC0gKiAqKiBQbGVhc2UgdXBkYXRlIERvY3VtZW50YXRpb24v
cHJpbnRrLWZvcm1hdHMudHh0IHdoZW4gbWFraW5nIA0KPiA+IGNoYW5nZXMgKioNCj4gPiArICog
KiogUGxlYXNlIHVwZGF0ZSB0aGUgZG9jdW1lbnRhdGlvbiB3aGVuIG1ha2luZyBjaGFuZ2VzICoq
DQo+ID4gICAqDQo+ID4gICAqIFRoZSByZXR1cm4gdmFsdWUgaXMgdGhlIG51bWJlciBvZiBjaGFy
YWN0ZXJzIHdoaWNoIHdvdWxkDQo+ID4gICAqIGJlIGdlbmVyYXRlZCBmb3IgdGhlIGdpdmVuIGlu
cHV0LCBleGNsdWRpbmcgdGhlIHRyYWlsaW5nDQo+IA0KDQotLSANCkFuZHkgU2hldmNoZW5rbyA8
YW5kcml5LnNoZXZjaGVua29AaW50ZWwuY29tPg0KSW50ZWwgRmlubGFuZCBPeQotLS0tLS0tLS0t
LS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0t
LS0KSW50ZWwgRmlubGFuZCBPeQpSZWdpc3RlcmVkIEFkZHJlc3M6IFBMIDI4MSwgMDAxODEgSGVs
c2lua2kgCkJ1c2luZXNzIElkZW50aXR5IENvZGU6IDAzNTc2MDYgLSA0IApEb21pY2lsZWQgaW4g
SGVsc2lua2kgCgpUaGlzIGUtbWFpbCBhbmQgYW55IGF0dGFjaG1lbnRzIG1heSBjb250YWluIGNv
bmZpZGVudGlhbCBtYXRlcmlhbCBmb3IKdGhlIHNvbGUgdXNlIG9mIHRoZSBpbnRlbmRlZCByZWNp
cGllbnQocykuIEFueSByZXZpZXcgb3IgZGlzdHJpYnV0aW9uCmJ5IG90aGVycyBpcyBzdHJpY3Rs
eSBwcm9oaWJpdGVkLiBJZiB5b3UgYXJlIG5vdCB0aGUgaW50ZW5kZWQKcmVjaXBpZW50LCBwbGVh
c2UgY29udGFjdCB0aGUgc2VuZGVyIGFuZCBkZWxldGUgYWxsIGNvcGllcy4K

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [next] | [standalone]

#1232090 — Re: [PATCH v2] lib: Documentation: Synchronize %p formatting documentation

FromMartin Kletzander <mkletzan@redhat.com>
Date2015-09-24 14:40 +0200
SubjectRe: [PATCH v2] lib: Documentation: Synchronize %p formatting documentation
Message-ID<qcdYC-36h-1@gated-at.bofh.it>
In reply to#1231945

[Multipart message — attachments visible in raw view] — view raw

On Thu, Sep 24, 2015 at 08:20:27AM +0000, Shevchenko, Andriy wrote:
>On Thu, 2015-09-24 at 11:16 +0300, Andy Shevchenko wrote:
>> On Thu, 2015-09-24 at 10:08 +0200, Martin Kletzander wrote:
>> > Move all pointer-formatting documentation to one place in the code
>> > and
>> > one place in the documentation instead of keeping it in three
>> > places
>> > with different level of completeness.  Documentation/printk
>> > -formats.txt
>> > has detailed information about each modifier, docstring above
>> > pointer()
>> > has short descriptions of them (as that is the function dealing
>> > with
>> > %p)
>> > and docstring above vsprintf() is removed as redundant.  Both
>> > docstrings
>> > in the code that were modified are updated with a reminder of
>> > updating
>> > the documentation upon any further change.
>> >
>>
>> Good for me!
>>
>> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
>>
>
>Ah, sorry, it seems you have to distinguish %pn (which seems now as %p
>+ n if I didn't miss anything) and %n.
>

Sorry, my bad, thanks for catching that.

>After addressing this, take my above tag.
>

I added few more tiny fixes (see diff below), is it still OK for me to
add the Reviewed-by there?

Martin

diff --git i/Documentation/printk-formats.txt w/Documentation/printk-formats.txt
index c85e27264a2b..f6d1ab6b1165 100644
--- i/Documentation/printk-formats.txt
+++ w/Documentation/printk-formats.txt
@@ -315,9 +315,11 @@ Command from struct task_struct

 Ignored argument:

-	%pn
+	%n	%n

-	The argument passed will be ignored.
+	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 i/lib/vsprintf.c w/lib/vsprintf.c
index 07205016415d..3e66fbbae8cd 100644
--- i/lib/vsprintf.c
+++ w/lib/vsprintf.c
@@ -1465,7 +1465,7 @@ int kptr_restrict __read_mostly;
  * - 'Cr' For a clock, it prints the current rate of the clock
  * - 'T' For task_struct->comm
  *
- * ** Please update Documentation/printk-formats.txt when making changes **
+ * ** Please update also Documentation/printk-formats.txt when making changes **
  *
  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
  * function pointers are really function descriptors, which contain a
@@ -1831,11 +1831,14 @@ qualifier:
  * @fmt: The format string to use
  * @args: Arguments for the format string
  *
- * This function follows C99 vsnprintf, but has some extensions.  See
- * pointer() or Documentation/printk-formats.txt for all format
- * specifiers.
+ * This function follows C99 vsnprintf, but has some extensions:
+ * %n is ignored
+ * %p* is handled by pointer()
+ *
+ * See pointer() or Documentation/printk-formats.txt for more
+ * extensive description.
  *
- * ** Please update the documentation when making changes **
+ * ** Please update the documentation on both places when making changes **
  *
  * The return value is the number of characters which would
  * be generated for the given input, excluding the trailing
--

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web