Re: [PATCH] OpenACC documentation for libgomp

[James Norris <jnorris@codesourcery.com>]

Bernd,

On 01/11/2016 11:23 AM, Bernd Schmidt wrote:
> On 01/05/2016 04:47 PM, James Norris wrote:
>> I've updated the original patch after some very helpful
>> comments from Sandra (thank you, thank you).
>>
>> OK to commit to trunk?
>
> I'm probably not fully qualified to review the contents either, but few people
> are and it looks reasonable enough that I guess I'll just ack it. Before that,
> some questions though:
>
>> +@item @emph{Fortran}:
>> +@multitable @columnfractions .20 .80
>> +@item @emph{Prototype}: @tab @code{function acc_async_test(arg);}
>> +@item                   @tab @code{integer(kind=acc_handle_kind) arg}
>> +@item                   @tab @code{logical acc_async_test}
>> +@end multitable
>
> I guess this is how Fortran functions and their args/return values are
> documented? Do we have other examples of this somewhere?

Yes, in the earlier section that describes OpenMP. One thing
that needs changing is 'Prototype' should be changed to 'Interface'
for Fortran.

>> +about @env{ACC_DEVICE_TYPE} and @env{ACC_DEVICE_NUM} can be found in
>> +sections 4.1 and 4.2 of the “The OpenACC
>> +Application Programming Interface”, Version 2.0, June, 2013.}.
>
> Non-ascii characters. I'm guessing this should probably be some kind of texinfo
> @something{} block; OTOH references to C standards in standards.texi just name
> them in plain text.

As Jakub pointed out in followup, those instances should
be using a @uref and not double quoted.

>
> I wonder if things like OpenMP and OpenACC should be mentioned in
> standards.texi, but that is tangential to this patch.
>

That's a good idea. Thanks!

Thanks for taking the time for the review.

Jim