This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Don't document the types of standard typedefs
- From: "Joseph S. Myers" <joseph at codesourcery dot com>
- To: libc-alpha at sourceware dot org
- Date: Mon, 27 Feb 2012 00:31:29 +0000 (UTC)
- Subject: Don't document the types of standard typedefs
Given the conclusion in
<http://sourceware.org/ml/libc-alpha/2012-02/msg00454.html> that "GNU
system" references should change to use various Texinfo macros
depending on exactly what we think is being referred to in each case,
I propose this patch which does some preliminary cleanup by removing
"GNU system" references where I think removal, not converting to a new
macro, is the right fix.
The text removed describes the types to which various standard
typedefs are supposed to be equivalent on the GNU system. To the
extent that this is accurate for GNU Hurd it's mainly because of the
lack of a 64-bit port. Since users should avoid relying on the
equivalence of these typedefs to any particular type, I think it's
most appropriate not to document those equivalences. (For off_t, the
reference to fpos_t is simply wrong for glibc; fpos_t is a struct,
necessarily so to include an mbstate_t.)
2012-02-27 Joseph Myers <joseph@codesourcery.com>
* manual/filesys.texi (mode_t): Do not mention what standard type
this is equivalent to.
(ino_t): Likewise.
(ino64_t): Likewise.
(dev_t): Likewise.
(nlink_t): Likewise.
(blkcnt_t): Likewise.
(blkcnt64_t): Likewise.
* manual/llio.texi (off_t): Do not refer to equivalence to fpos_t
or long int.
diff --git a/manual/filesys.texi b/manual/filesys.texi
index 049e7e0..5a128f3 100644
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -1770,8 +1770,7 @@ Here is a list of them.
@comment sys/types.h
@comment POSIX.1
@deftp {Data Type} mode_t
-This is an integer data type used to represent file modes. In the
-GNU system, this is equivalent to @code{unsigned int}.
+This is an integer data type used to represent file modes.
@end deftp
@cindex inode number
@@ -1780,7 +1779,6 @@ GNU system, this is equivalent to @code{unsigned int}.
@deftp {Data Type} ino_t
This is an arithmetic data type used to represent file serial numbers.
(In Unix jargon, these are sometimes called @dfn{inode numbers}.)
-In the GNU system, this type is equivalent to @code{unsigned long int}.
If the source is compiled with @code{_FILE_OFFSET_BITS == 64} this type
is transparently replaced by @code{ino64_t}.
@@ -1790,8 +1788,7 @@ is transparently replaced by @code{ino64_t}.
@comment Unix98
@deftp {Data Type} ino64_t
This is an arithmetic data type used to represent file serial numbers
-for the use in LFS. In the GNU system, this type is equivalent to
-@code{unsigned long long int}.
+for the use in LFS.
When compiling with @code{_FILE_OFFSET_BITS == 64} this type is
available under the name @code{ino_t}.
@@ -1801,21 +1798,18 @@ available under the name @code{ino_t}.
@comment POSIX.1
@deftp {Data Type} dev_t
This is an arithmetic data type used to represent file device numbers.
-In the GNU system, this is equivalent to @code{int}.
@end deftp
@comment sys/types.h
@comment POSIX.1
@deftp {Data Type} nlink_t
This is an arithmetic data type used to represent file link counts.
-In the GNU system, this is equivalent to @code{unsigned short int}.
@end deftp
@comment sys/types.h
@comment Unix98
@deftp {Data Type} blkcnt_t
This is an arithmetic data type used to represent block counts.
-In the GNU system, this is equivalent to @code{unsigned long int}.
If the source is compiled with @code{_FILE_OFFSET_BITS == 64} this type
is transparently replaced by @code{blkcnt64_t}.
@@ -1825,8 +1819,7 @@ is transparently replaced by @code{blkcnt64_t}.
@comment Unix98
@deftp {Data Type} blkcnt64_t
This is an arithmetic data type used to represent block counts for the
-use in LFS. In the GNU system, this is equivalent to @code{unsigned
-long long int}.
+use in LFS.
When compiling with @code{_FILE_OFFSET_BITS == 64} this type is
available under the name @code{blkcnt_t}.
diff --git a/manual/llio.texi b/manual/llio.texi
index 8154de7..da39c4a 100644
--- a/manual/llio.texi
+++ b/manual/llio.texi
@@ -777,7 +777,6 @@ character.
@comment POSIX.1
@deftp {Data Type} off_t
This is an arithmetic data type used to represent file sizes.
-In the GNU system, this is equivalent to @code{fpos_t} or @code{long int}.
If the source is compiled with @code{_FILE_OFFSET_BITS == 64} this type
is transparently replaced by @code{off64_t}.
--
Joseph S. Myers
joseph@codesourcery.com