This is the mail archive of the newlib@sourceware.org mailing list for the newlib project.
Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]
Other format:	[Raw text]
[PATCH 2/3] Consistently use '---' (em dash) in summaries in documentation FUNCTION sections

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: Tue, 27 Oct 2015 16:09:08 +0000
Subject: [PATCH 2/3] Consistently use '---' (em dash) in summaries in documentation FUNCTION sections
Authentication-results: sourceware.org; auth=none
References: <1445962149-3836-1-git-send-email-jon dot turney at dronecode dot org dot uk>
In texinfo source, '---' means a long dash (em dash), '--' means a medium dash
(en dash).  Consistenly use em dash, as that's what the majority of summaries
use.

2015-10-27  Jon Turney  <jon.turney@dronecode.org.uk>

	* libc/time/wcsftime.c: Consistently use an em-dash in FUNCTION
	summary.
	* libm/common/isgreater.c: Ditto.
	* libm/common/s_fdim.c: Ditto.
	* libm/common/s_fma.c: Ditto.
	* libm/common/s_fmax.c: Ditto.
	* libm/common/s_fmin.c: Ditto.
	* libm/common/s_infinity.c: Ditto.
	* libm/common/s_isnan.c: Ditto.
	* libm/common/s_log2.c: Ditto.
	* libm/common/s_logb.c: Ditto.
	* libm/common/s_lrint.c: Ditto.
	* libm/common/s_lround.c: Ditto.
	* libm/common/s_nearbyint.c: Ditto.
	* libm/common/s_remquo.c: Ditto.
	* libm/common/s_rint.c: Ditto.
	* libm/common/s_round.c: Ditto.
	* libm/common/s_scalbn.c: Ditto.
	* libm/common/s_signbit.c: Ditto.
	* libm/common/s_trunc.c: Ditto.
	* libm/math/w_exp2.c: Ditto.
	* libm/math/w_gamma.c: Ditto.

Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
---
 newlib/ChangeLog                 | 25 +++++++++++++++++++++++++
 newlib/libc/time/wcsftime.c      |  2 +-
 newlib/libm/common/isgreater.c   |  2 +-
 newlib/libm/common/s_fdim.c      |  2 +-
 newlib/libm/common/s_fma.c       |  2 +-
 newlib/libm/common/s_fmax.c      |  2 +-
 newlib/libm/common/s_fmin.c      |  2 +-
 newlib/libm/common/s_infinity.c  |  2 +-
 newlib/libm/common/s_isnan.c     |  2 +-
 newlib/libm/common/s_log2.c      |  2 +-
 newlib/libm/common/s_logb.c      |  2 +-
 newlib/libm/common/s_lrint.c     |  2 +-
 newlib/libm/common/s_lround.c    |  2 +-
 newlib/libm/common/s_nearbyint.c |  2 +-
 newlib/libm/common/s_remquo.c    |  2 +-
 newlib/libm/common/s_rint.c      |  2 +-
 newlib/libm/common/s_round.c     |  2 +-
 newlib/libm/common/s_scalbn.c    |  2 +-
 newlib/libm/common/s_signbit.c   |  2 +-
 newlib/libm/common/s_trunc.c     |  2 +-
 newlib/libm/math/w_exp2.c        |  2 +-
 newlib/libm/math/w_gamma.c       |  2 +-
 22 files changed, 46 insertions(+), 21 deletions(-)

diff --git a/newlib/ChangeLog b/newlib/ChangeLog
index 0e83aca..6523a57 100644
--- a/newlib/ChangeLog
+++ b/newlib/ChangeLog
@@ -1,5 +1,30 @@
 2015-10-27  Jon Turney  <jon.turney@dronecode.org.uk>
 
+	* libc/time/wcsftime.c: Consistently use an em-dash in FUNCTION
+	summary.
+	* libm/common/isgreater.c: Ditto.
+	* libm/common/s_fdim.c: Ditto.
+	* libm/common/s_fma.c: Ditto.
+	* libm/common/s_fmax.c: Ditto.
+	* libm/common/s_fmin.c: Ditto.
+	* libm/common/s_infinity.c: Ditto.
+	* libm/common/s_isnan.c: Ditto.
+	* libm/common/s_log2.c: Ditto.
+	* libm/common/s_logb.c: Ditto.
+	* libm/common/s_lrint.c: Ditto.
+	* libm/common/s_lround.c: Ditto.
+	* libm/common/s_nearbyint.c: Ditto.
+	* libm/common/s_remquo.c: Ditto.
+	* libm/common/s_rint.c: Ditto.
+	* libm/common/s_round.c: Ditto.
+	* libm/common/s_scalbn.c: Ditto.
+	* libm/common/s_signbit.c: Ditto.
+	* libm/common/s_trunc.c: Ditto.
+	* libm/math/w_exp2.c: Ditto.
+	* libm/math/w_gamma.c: Ditto.
+
+2015-10-27  Jon Turney  <jon.turney@dronecode.org.uk>
+
 	* libc/stdio/fseek.c: Add missing semicolons to prototypes in
 	SYNOPSIS.
 	* libc/stdio/fwide.c: Ditto.
diff --git a/newlib/libc/time/wcsftime.c b/newlib/libc/time/wcsftime.c
index ac71a09..f77b3d0 100644
--- a/newlib/libc/time/wcsftime.c
+++ b/newlib/libc/time/wcsftime.c
@@ -8,7 +8,7 @@
 
 /*
 FUNCTION
-<<wcsftime>>--convert date and time to a formatted wide-character string
+<<wcsftime>>---convert date and time to a formatted wide-character string
 
 INDEX
 	wcsftime
diff --git a/newlib/libm/common/isgreater.c b/newlib/libm/common/isgreater.c
index bd4e95e..54a8e6d 100644
--- a/newlib/libm/common/isgreater.c
+++ b/newlib/libm/common/isgreater.c
@@ -3,7 +3,7 @@
  * defined in math.h (q.v.).  */
 /*
 FUNCTION
-<<isgreater>>, <<isgreaterequal>>, <<isless>>, <<islessequal>>, <<islessgreater>>, and <<isunordered>>--comparison macros
+<<isgreater>>, <<isgreaterequal>>, <<isless>>, <<islessequal>>, <<islessgreater>>, and <<isunordered>>---comparison macros
 INDEX
 	isgreater
 INDEX
diff --git a/newlib/libm/common/s_fdim.c b/newlib/libm/common/s_fdim.c
index 8eb8782..a6c465c 100644
--- a/newlib/libm/common/s_fdim.c
+++ b/newlib/libm/common/s_fdim.c
@@ -5,7 +5,7 @@
  */
 /*
 FUNCTION
-<<fdim>>, <<fdimf>>--positive difference
+<<fdim>>, <<fdimf>>---positive difference
 INDEX
 	fdim
 INDEX
diff --git a/newlib/libm/common/s_fma.c b/newlib/libm/common/s_fma.c
index 964a828..bbb3eb0 100644
--- a/newlib/libm/common/s_fma.c
+++ b/newlib/libm/common/s_fma.c
@@ -1,6 +1,6 @@
 /*
 FUNCTION
-<<fma>>, <<fmaf>>--floating multiply add
+<<fma>>, <<fmaf>>---floating multiply add
 INDEX
 	fma
 INDEX
diff --git a/newlib/libm/common/s_fmax.c b/newlib/libm/common/s_fmax.c
index 4003f9a..8f446e2 100644
--- a/newlib/libm/common/s_fmax.c
+++ b/newlib/libm/common/s_fmax.c
@@ -5,7 +5,7 @@
  */
 /*
 FUNCTION
-<<fmax>>, <<fmaxf>>--maximum
+<<fmax>>, <<fmaxf>>---maximum
 INDEX
 	fmax
 INDEX
diff --git a/newlib/libm/common/s_fmin.c b/newlib/libm/common/s_fmin.c
index 2a05920..2d0cd80 100644
--- a/newlib/libm/common/s_fmin.c
+++ b/newlib/libm/common/s_fmin.c
@@ -5,7 +5,7 @@
  */
 /*
 FUNCTION
-<<fmin>>, <<fminf>>--minimum
+<<fmin>>, <<fminf>>---minimum
 INDEX
 	fmin
 INDEX
diff --git a/newlib/libm/common/s_infinity.c b/newlib/libm/common/s_infinity.c
index 02a545e..9285a76 100644
--- a/newlib/libm/common/s_infinity.c
+++ b/newlib/libm/common/s_infinity.c
@@ -5,7 +5,7 @@
 
 /*
 FUNCTION
-	<<infinity>>, <<infinityf>>--representation of infinity
+	<<infinity>>, <<infinityf>>---representation of infinity
 
 INDEX
 	infinity
diff --git a/newlib/libm/common/s_isnan.c b/newlib/libm/common/s_isnan.c
index 5ae6c9b..3ce5aa6 100644
--- a/newlib/libm/common/s_isnan.c
+++ b/newlib/libm/common/s_isnan.c
@@ -13,7 +13,7 @@
 
 /*
 FUNCTION
-<<fpclassify>>, <<isfinite>>, <<isinf>>, <<isnan>>, and <<isnormal>>--floating-point classification macros; <<finite>>, <<finitef>>, <<isinf>>, <<isinff>>, <<isnan>>, <<isnanf>>--test for exceptional numbers
+<<fpclassify>>, <<isfinite>>, <<isinf>>, <<isnan>>, and <<isnormal>>---floating-point classification macros; <<finite>>, <<finitef>>, <<isinf>>, <<isinff>>, <<isnan>>, <<isnanf>>---test for exceptional numbers
 
 @c C99 (start
 INDEX
diff --git a/newlib/libm/common/s_log2.c b/newlib/libm/common/s_log2.c
index e508785..3b05066 100644
--- a/newlib/libm/common/s_log2.c
+++ b/newlib/libm/common/s_log2.c
@@ -14,7 +14,7 @@
 
 /*
 FUNCTION
-	<<log2>>, <<log2f>>--base 2 logarithm
+	<<log2>>, <<log2f>>---base 2 logarithm
 INDEX
 	log2
 INDEX
diff --git a/newlib/libm/common/s_logb.c b/newlib/libm/common/s_logb.c
index 1be4cdd..7e71457 100644
--- a/newlib/libm/common/s_logb.c
+++ b/newlib/libm/common/s_logb.c
@@ -12,7 +12,7 @@
  */
 /*
 FUNCTION
-       <<logb>>, <<logbf>>--get exponent of floating-point number
+       <<logb>>, <<logbf>>---get exponent of floating-point number
 INDEX
 	logb
 INDEX
diff --git a/newlib/libm/common/s_lrint.c b/newlib/libm/common/s_lrint.c
index cf35dcf..52bb522 100644
--- a/newlib/libm/common/s_lrint.c
+++ b/newlib/libm/common/s_lrint.c
@@ -12,7 +12,7 @@
  */
 /*
 FUNCTION
-<<lrint>>, <<lrintf>>, <<llrint>>, <<llrintf>>--round to integer
+<<lrint>>, <<lrintf>>, <<llrint>>, <<llrintf>>---round to integer
 INDEX
 	lrint
 INDEX
diff --git a/newlib/libm/common/s_lround.c b/newlib/libm/common/s_lround.c
index 7c1eb31..52cd74f 100644
--- a/newlib/libm/common/s_lround.c
+++ b/newlib/libm/common/s_lround.c
@@ -10,7 +10,7 @@
  */
 /*
 FUNCTION
-<<lround>>, <<lroundf>>, <<llround>>, <<llroundf>>--round to integer, to nearest
+<<lround>>, <<lroundf>>, <<llround>>, <<llroundf>>---round to integer, to nearest
 INDEX
 	lround
 INDEX
diff --git a/newlib/libm/common/s_nearbyint.c b/newlib/libm/common/s_nearbyint.c
index e7a0220..714b66a 100644
--- a/newlib/libm/common/s_nearbyint.c
+++ b/newlib/libm/common/s_nearbyint.c
@@ -10,7 +10,7 @@
  */
 /*
 FUNCTION
-<<nearbyint>>, <<nearbyintf>>--round to integer
+<<nearbyint>>, <<nearbyintf>>---round to integer
 INDEX
 	nearbyint
 INDEX
diff --git a/newlib/libm/common/s_remquo.c b/newlib/libm/common/s_remquo.c
index 8ae2875..30bf15f 100644
--- a/newlib/libm/common/s_remquo.c
+++ b/newlib/libm/common/s_remquo.c
@@ -13,7 +13,7 @@
  */
 /*
 FUNCTION
-<<remquo>>, <<remquof>>--remainder and part of quotient
+<<remquo>>, <<remquof>>---remainder and part of quotient
 INDEX
 	remquo
 INDEX
diff --git a/newlib/libm/common/s_rint.c b/newlib/libm/common/s_rint.c
index 76cff08..f06325a 100644
--- a/newlib/libm/common/s_rint.c
+++ b/newlib/libm/common/s_rint.c
@@ -12,7 +12,7 @@
  */
 /*
 FUNCTION
-<<rint>>, <<rintf>>--round to integer
+<<rint>>, <<rintf>>---round to integer
 INDEX
 	rint
 INDEX
diff --git a/newlib/libm/common/s_round.c b/newlib/libm/common/s_round.c
index b2cc0f5..07aac9e 100644
--- a/newlib/libm/common/s_round.c
+++ b/newlib/libm/common/s_round.c
@@ -10,7 +10,7 @@
  */
 /*
 FUNCTION
-<<round>>, <<roundf>>--round to integer, to nearest
+<<round>>, <<roundf>>---round to integer, to nearest
 INDEX
 	round
 INDEX
diff --git a/newlib/libm/common/s_scalbn.c b/newlib/libm/common/s_scalbn.c
index 50f20ef..7fab586 100644
--- a/newlib/libm/common/s_scalbn.c
+++ b/newlib/libm/common/s_scalbn.c
@@ -13,7 +13,7 @@
 
 /*
 FUNCTION
-<<scalbn>>, <<scalbnf>>, <<scalbln>>, <<scalblnf>>--scale by power of FLT_RADIX (=2)
+<<scalbn>>, <<scalbnf>>, <<scalbln>>, <<scalblnf>>---scale by power of FLT_RADIX (=2)
 INDEX
 	scalbn
 INDEX
diff --git a/newlib/libm/common/s_signbit.c b/newlib/libm/common/s_signbit.c
index 6ea714d..d2ba1fc 100644
--- a/newlib/libm/common/s_signbit.c
+++ b/newlib/libm/common/s_signbit.c
@@ -5,7 +5,7 @@
  */
 /*
 FUNCTION
-<<signbit>>--Does floating-point number have negative sign?
+<<signbit>>---Does floating-point number have negative sign?
 
 INDEX
 	signbit
diff --git a/newlib/libm/common/s_trunc.c b/newlib/libm/common/s_trunc.c
index daeb791..31a1f92 100644
--- a/newlib/libm/common/s_trunc.c
+++ b/newlib/libm/common/s_trunc.c
@@ -10,7 +10,7 @@
  */
 /*
 FUNCTION
-<<trunc>>, <<truncf>>--round to integer, towards zero
+<<trunc>>, <<truncf>>---round to integer, towards zero
 INDEX
 	trunc
 INDEX
diff --git a/newlib/libm/math/w_exp2.c b/newlib/libm/math/w_exp2.c
index efb676d..857cb0c 100644
--- a/newlib/libm/math/w_exp2.c
+++ b/newlib/libm/math/w_exp2.c
@@ -13,7 +13,7 @@
 
 /*
 FUNCTION
-	<<exp2>>, <<exp2f>>--exponential, base 2
+	<<exp2>>, <<exp2f>>---exponential, base 2
 INDEX
 	exp2
 INDEX
diff --git a/newlib/libm/math/w_gamma.c b/newlib/libm/math/w_gamma.c
index 3717f53..d1a70df 100644
--- a/newlib/libm/math/w_gamma.c
+++ b/newlib/libm/math/w_gamma.c
@@ -24,7 +24,7 @@ gamma function.
 matching a newer, better definition.  */
 /*
 FUNCTION
-        <<gamma>>, <<gammaf>>, <<lgamma>>, <<lgammaf>>, <<gamma_r>>, <<gammaf_r>>, <<lgamma_r>>, <<lgammaf_r>>, <<tgamma>>, and <<tgammaf>>--logarithmic and plain gamma functions
+        <<gamma>>, <<gammaf>>, <<lgamma>>, <<lgammaf>>, <<gamma_r>>, <<gammaf_r>>, <<lgamma_r>>, <<lgammaf_r>>, <<tgamma>>, and <<tgammaf>>---logarithmic and plain gamma functions
 
 INDEX
 gamma
-- 
2.5.3
References:
- [PATCH 0/3] Documentation cleanups
  - From: Jon Turney
Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]