Documentation: providing a more precise description of a parameter of the kmpc_taskloop function

[smateo]

Summary

Some time ago I opened the following revision to fix an issue related to the implicit taskgroup associated with a taskloop construct that doesn't have the nogroup clause:

https://bugs.llvm.org/show_bug.cgi?id=37737
https://reviews.llvm.org/D53636

Those changes were upstreamed, but I forgot to update the documentation. This revision tries to address that.

In clang we explicitly materialize the implicit taskgroup when it is required. Thus, we always pass a 1 as the value of the nogroup parameter. Since this parameter doesn't represent whether the nogroup clause was present but whether we want to create a taskgroup region inside the kmpc_taskloop function, I think we should change its description.

[AndreyChurbanov]

LG

Sergi, do you have commit rights? I can commit it otherwise. Thanks.

[smateo]

Hi Andrey,

I don't, so if you could commit it I'd appreciate it.

Thank you for your time!
Sergi

runtime/src/kmp_tasking.cpp

 @ingroup TASKING
 @param loc       Source location information
 @param gtid      Global thread ID
 @param task      Task structure
 @param if_val    Value of the if clause
 @param lb        Pointer to loop lower bound in task structure
 @param ub        Pointer to loop upper bound in task structure
 @param st        Loop stride
-@param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
+@param nogroup   Flag, 1 if no taskgroup needs to be added, 0 otherwise
 @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
 @param grainsize Schedule value if specified
 @param task_dup  Tasks duplication routine
 
 Execute the taskloop construct.
 */
 void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,