about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2017-06-20 06:39:27 -0700
committerRical Jasan <ricaljasan@pacific.net>2017-07-27 04:47:42 -0700
commitd3675d957b9427d4d119250514a25aaba78d26de (patch)
treed0da2b89d0b215876ebf42946ad46bf8efe0afef
parent88f9e739432dc950b1f28638158d6dbb1ebd0361 (diff)
downloadglibc-d3675d957b9427d4d119250514a25aaba78d26de.tar.gz
glibc-d3675d957b9427d4d119250514a25aaba78d26de.tar.xz
glibc-d3675d957b9427d4d119250514a25aaba78d26de.zip
manual: Refactor documentation of CHAR_BIT.
This single-@item @table is better defined with @deftypevr, since the
CHAR_BIT macro has @standards (being declared in a header), and @items
in @tables are not considered annotatable.  Using @deftypevr
automatically includes the macro in the Variable and Constant Macro
Index and ensures its inclusion the Summary of Library Facilities.
@deftypevr is used to record the type of the macro so that it also
appears in the Summary.

The description is updated to mention a later POSIX requirement that
this macro have the value 8.

	* manual/lang.texi (CHAR_BIT): Convert from an @table to an
	@deftypevr.  Change standard from ISO to C90.  Mention the
	POSIX.1-2001 requirement of the value 8.
-rw-r--r--ChangeLog6
-rw-r--r--manual/lang.texi11
2 files changed, 11 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index 5ca4770e57..8850e53bc2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2017-07-27  Rical Jasan  <ricaljasan@pacific.net>
 
+	* manual/lang.texi (CHAR_BIT): Convert from an @table to an
+	@deftypevr.  Change standard from ISO to C90.  Mention the
+	POSIX.1-2001 requirement of the value 8.
+
+2017-07-27  Rical Jasan  <ricaljasan@pacific.net>
+
 	* manual/creature.texi (_REENTRANT): Annotate as obsolete.
 	(_THREAD_SAFE): Likewise.
 
diff --git a/manual/lang.texi b/manual/lang.texi
index c4b641d4e1..75af677dc9 100644
--- a/manual/lang.texi
+++ b/manual/lang.texi
@@ -628,11 +628,10 @@ There is no operator in the C language that can give you the number of
 bits in an integer data type.  But you can compute it from the macro
 @code{CHAR_BIT}, defined in the header file @file{limits.h}.
 
-@table @code
-@item CHAR_BIT
-@standards{ISO, limits.h}
-This is the number of bits in a @code{char}---eight, on most systems.
-The value has type @code{int}.
+@deftypevr Macro int CHAR_BIT
+@standards{C90, limits.h}
+This is the number of bits in a @code{char}.  POSIX.1-2001 requires
+this to be 8.
 
 You can compute the number of bits in any data type @var{type} like
 this:
@@ -640,7 +639,7 @@ this:
 @smallexample
 sizeof (@var{type}) * CHAR_BIT
 @end smallexample
-@end table
+@end deftypevr
 
 That expression includes padding bits as well as value and sign bits.
 On all systems supported by @theglibc{}, standard integer types other