manual: Refactor documentation of CHAR_BIT.
authorRical Jasan <ricaljasan@pacific.net>
Tue, 20 Jun 2017 13:39:27 +0000 (06:39 -0700)
committerRical Jasan <ricaljasan@pacific.net>
Thu, 27 Jul 2017 11:47:42 +0000 (04:47 -0700)
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.

ChangeLog
manual/lang.texi

index 5ca4770..8850e53 100644 (file)
--- 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.
 
index c4b641d..75af677 100644 (file)
@@ -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