Re: [PATCH 1/2] system_data_types.7: Document size_t

Alejandro Colomar
2020-09-28T13:48:18Z

Hi Dave,

On 2020-09-28 15:41, Dave Martin wrote:
> On Fri, Sep 18, 2020 at 01:27:55PM +0200, Alejandro Colomar wrote:
>> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
>> ---
>> man7/system_data_types.7 | 103 +++++++++++++++++++++++++++++++++++++--
>> 1 file changed, 99 insertions(+), 4 deletions(-)
>>
>> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
>> index 84fea85b9..041e7e243 100644
>> --- a/man7/system_data_types.7
>> +++ b/man7/system_data_types.7
>
> The distinction might not be worth highlighting here, but types like
> size_t are a bit special in that they come from the C standards and
> assumptions about them are really built into the compiler.
>
> The system can define its own size_t, but it had better be equivalent
> to the compiler's definition otherwise bad things will
> happen...
>
>
>> @@ -92,6 +92,101 @@ See also:
>> .\".I siginfo_t
>> .\"type in this page.
>> .TP
>> +.I size_t
>> +.IP
>> +Include:
>> +.I <stddef.h>
>> +or
>
> Where does this arbitrary-looking list of headers come from?

There are two parts: left to the ';', and right to the ';'.

Left: The canonical C standard header, and the canonical POSIX header,
in alphabetical order.

Right: All other headers that shall define the header, according to
either the C or the POSIX standards, in alphabetical order.

Cheers,

Alex

>
> From the C standards at least, <stddef.h> seems to be the canonical
> header for this type.
>
>
>> +.IR <sys/types.h> ;
>> +or
>> +.I <aio.h>
>> +or
>> +.I <glob.h>
>> +or
>> +.I <grp.h>
>> +or
>> +.I <iconv.h>
>> +or
>> +.I <monetary.h>
>> +or
>> +.I <mqueue.h>
>
> [...]
>
> Cheers
> ---Dave
>