Re: [gomp4.1] document more structures in libgomp.h

[Jakub Jelinek <jakub@redhat.com>]

On Fri, Aug 28, 2015 at 07:21:46AM -0700, Aldy Hernandez wrote:
>     	* libgomp.h: Document gomp_task_depend_entry, gomp_task,
>     	gomp_taskgroup.
>     	*task.c (gomp_task_run_pre): Add comments.

Missing space before task.c.

> --- a/libgomp/libgomp.h
> +++ b/libgomp/libgomp.h
> @@ -279,9 +279,11 @@ struct htab;
>  
>  struct gomp_task_depend_entry
>  {
> +  /* Address of dependency.  */
>    void *addr;
>    struct gomp_task_depend_entry *next;
>    struct gomp_task_depend_entry *prev;
> +  /* Task that provides the depdency in ADDR.  */

Typo.

>    struct gomp_task *task;
>    /* Depend entry is of type "IN".  */
>    bool is_in;
> @@ -312,10 +314,14 @@ struct gomp_taskwait
>  struct gomp_task
>  {
>    struct gomp_task *parent;
> +  /* Children of this task.  Siblings are chained by
> +     NEXT/PREV_CHILD fields below.  */

I think it would be better to say here that it is a circular list,
and how the siblings are ordered in the circular list.

>  struct gomp_taskgroup
>  {
>    struct gomp_taskgroup *prev;
> +  /* List of tasks that belong in this taskgroup.  Tasks are chained
> +     by next/prev_taskgroup within the gomp_task.  */

Again, perhaps mention also that it is a circular list and how the items of
the circular list are sorted.

> +  /* Scheduled tasks.  Chain fields are next/prev_queue within a
> +     gomp_task.  */

Similarly.
>    struct gomp_task *task_queue;


	Jakub