This is the mail archive of the libc-alpha@sourceware.org mailing list for the glibc 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]

Re: [PATCH v2 3/5] manual: Add new header and standards annotations.


While recapping my completion patches, I realized I missed committing
these.  The comment below about committing the approved parts to reduce
volume later is what kicked off my getting commit access, but then I
jumped into @standards, which became v3.

I verified the substance of the patches was unchanged, and updated them
to use @standards.  Any deviations from the OK'd portions are noted
below.  Each of the files is considered complete by summary.pl when
enforcing.

On 12/07/2016 08:31 AM, Joseph Myers wrote:
> On Tue, 6 Dec 2016, Rical Jasan wrote:
> 
>> diff --git a/manual/argp.texi b/manual/argp.texi
>> index bca3ca5..f1767cc 100644
>> --- a/manual/argp.texi
>> +++ b/manual/argp.texi
> 
> All the changes to this file are OK.

Committed as 76b9ffef.

>> diff --git a/manual/arith.texi b/manual/arith.texi
>> index 0c182c5..eee9880 100644
>> --- a/manual/arith.texi
>> +++ b/manual/arith.texi
> 
> All the changes to this file are OK.  Note for when making annotations 
> more consistent in standard naming in future that:
> 
>> @@ -714,7 +724,11 @@ such as by defining @code{_GNU_SOURCE}, and then you must include
>>  @comment math.h
>>  @comment ISO
>>  @deftypevr Macro float SNANF
>> +@comment math.h
>> +@comment TS 18661-1:2014
>>  @deftypevrx Macro double SNAN
>> +@comment math.h
>> +@comment TS 18661-1:2014
>>  @deftypevrx Macro {long double} SNANL
> 
> All three are TS 18661-1:2014.

Since a single @standards can annotate all of these, I used "TS
18661-1:2014".

>> @@ -2041,8 +2055,10 @@ NaN.
>>  @comment math.h
>>  @comment ISO
>>  @deftypefun int totalorder (double @var{x}, double @var{y})
>> +@comment math.h
>>  @comment ISO
>>  @deftypefunx int totalorderf (float @var{x}, float @var{y})
>> +@comment math.h
>>  @comment ISO
>>  @deftypefunx int totalorderl (long double @var{x}, long double @var{y})
>>  @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
>> @@ -2063,8 +2079,10 @@ payload.
>>  @comment math.h
>>  @comment ISO
>>  @deftypefun int totalordermag (double @var{x}, double @var{y})
>> +@comment math.h
>>  @comment ISO
>>  @deftypefunx int totalordermagf (float @var{x}, float @var{y})
>> +@comment math.h
>>  @comment ISO
>>  @deftypefunx int totalordermagl (long double @var{x}, long double @var{y})
> 
> As are all these.

Also used "TS 18661-1:2014" with a single @standards.

Other deviations in this file:

  * _Imaginary_I was not converted because it is in an @ignore block.
  * The strfrom[dfl] annotations were completed in 7d641c41.

Committed as 1b009d5a.

>> diff --git a/manual/lang.texi b/manual/lang.texi
>> index 6281840..5e4d1d3 100644
>> --- a/manual/lang.texi
>> +++ b/manual/lang.texi
> 
> All the changes to this file are OK apart from the question of whether to 
> document __va_copy at all.

I think this file is better served by a different set of changes at this
point, so I will submit that for review separately.

>> diff --git a/manual/string.texi b/manual/string.texi
>> index 1986357..683a20f 100644
>> --- a/manual/string.texi
>> +++ b/manual/string.texi
> 
> All the changes to this file are OK.

Committed as a448ee41.

This one highlights an issue with summary.pl, where even when enforcing,
it currently doesn't catch these because the "???" placeholder is still
considered valid syntax (the annotated elements do have @standards).
However, this is something I took into consideration when writing the
script, so that once all the /^@standards.*\?\?\?/ have been addressed,
it should be a simple patch to consider it an error.

> I think the approved pieces should be committed to reduce the size of the 
> patch in future revisions.

Moving forward, I'll submit each chapter separately to help avoid that
problem.

Thank you,
Rical


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]