This is the mail archive of the
newlib@sourceware.org
mailing list for the newlib project.
[PATCH 2/2] Simplify the markup for sprintf and swprintf documentation
- From: Jon Turney <jon dot turney at dronecode dot org dot uk>
- To: newlib at sourceware dot org
- Cc: Jon Turney <jon dot turney at dronecode dot org dot uk>
- Date: Thu, 12 Nov 2015 14:21:44 +0000
- Subject: [PATCH 2/2] Simplify the markup for sprintf and swprintf documentation
- Authentication-results: sourceware.org; auth=none
- References: <1447338104-6932-1-git-send-email-jon dot turney at dronecode dot org dot uk>
- move the description of the alternative form produced with the # flag from a
nested table to an additional table
2015-11-12 Jon Turney <jon.turney@dronecode.org.uk>
* libc/stdio/sprintf.c: Simplify documentation markup.
* libc/stdio/swprintf.c: Ditto.
Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
---
newlib/ChangeLog | 5 ++++
newlib/libc/stdio/sprintf.c | 67 ++++++++++++++++++++++---------------------
newlib/libc/stdio/swprintf.c | 68 +++++++++++++++++++++++---------------------
3 files changed, 76 insertions(+), 64 deletions(-)
diff --git a/newlib/ChangeLog b/newlib/ChangeLog
index 5b7e94b..4f092ff 100644
--- a/newlib/ChangeLog
+++ b/newlib/ChangeLog
@@ -1,5 +1,10 @@
2015-11-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * libc/stdio/sprintf.c: Simplify documentation markup.
+ * libc/stdio/swprintf.c: Ditto.
+
+2015-11-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* libc/stdio/sscanf.c: Improve documentation markup.
* libc/stdio/swscanf.c: Ditto.
diff --git a/newlib/libc/stdio/sprintf.c b/newlib/libc/stdio/sprintf.c
index c3be9b1..d74c6f8 100644
--- a/newlib/libc/stdio/sprintf.c
+++ b/newlib/libc/stdio/sprintf.c
@@ -199,38 +199,41 @@ DESCRIPTION
o #
The result is to be converted to an
alternative form, according to the <[type]>
- character:
-
- o+
- o o
- Increases precision to force the first
- digit of the result to be a zero.
-
- o x
- A non-zero result will have a <<0x>>
- prefix.
-
- o X
- A non-zero result will have a <<0X>>
- prefix.
-
- o a, A, e, E, f, or F
- The result will always contain a
- decimal point even if no digits follow
- the point. (Normally, a decimal point
- appears only if a digit follows it.)
- Trailing zeros are removed.
-
- o g or G
- The result will always contain a
- decimal point even if no digits follow
- the point. Trailing zeros are not
- removed.
-
- o all others
- Undefined.
-
- o-
+ character.
+ o-
+
+ The alternative form output with the # flag depends on the <[type]>
+ character:
+
+ o+
+ o o
+ Increases precision to force the first
+ digit of the result to be a zero.
+
+ o x
+ A non-zero result will have a <<0x>>
+ prefix.
+
+ o X
+ A non-zero result will have a <<0X>>
+ prefix.
+
+ o a, A, e, E, f, or F
+ The result will always contain a
+ decimal point even if no digits follow
+ the point. (Normally, a decimal point
+ appears only if a digit follows it.)
+ Trailing zeros are removed.
+
+ o g or G
+ The result will always contain a
+ decimal point even if no digits follow
+ the point. Trailing zeros are not
+ removed.
+
+ o all others
+ Undefined.
+
o-
o <[width]>
diff --git a/newlib/libc/stdio/swprintf.c b/newlib/libc/stdio/swprintf.c
index 60178e5..2233b3b 100644
--- a/newlib/libc/stdio/swprintf.c
+++ b/newlib/libc/stdio/swprintf.c
@@ -167,40 +167,44 @@ DESCRIPTION
o #
The result is to be converted to an
alternative form, according to the <[type]>
- character:
-
- o+
- o o
- Increases precision to force the first
- digit of the result to be a zero.
-
- o x
- A non-zero result will have a <<0x>>
- prefix.
-
- o X
- A non-zero result will have a <<0X>>
- prefix.
-
- o a, A, e, E, f, or F
- The result will always contain a
- decimal point even if no digits follow
- the point. (Normally, a decimal point
- appears only if a digit follows it.)
- Trailing zeros are removed.
-
- o g or G
- The result will always contain a
- decimal point even if no digits follow
- the point. Trailing zeros are not
- removed.
-
- o all others
- Undefined.
-
- o-
+ character.
o-
+ The alternative form output with the # flag depends on the <[type]>
+ character:
+
+ o+
+ o o
+ Increases precision to force the first
+ digit of the result to be a zero.
+
+ o x
+ A non-zero result will have a <<0x>>
+ prefix.
+
+ o X
+ A non-zero result will have a <<0X>>
+ prefix.
+
+ o a, A, e, E, f, or F
+ The result will always contain a
+ decimal point even if no digits follow
+ the point. (Normally, a decimal point
+ appears only if a digit follows it.)
+ Trailing zeros are removed.
+
+ o g or G
+ The result will always contain a
+ decimal point even if no digits follow
+ the point. Trailing zeros are not
+ removed.
+
+ o all others
+ Undefined.
+
+ o-
+
+
o <[width]>
<[width]> is an optional minimum field width. You can
--
2.5.3