Overall document structure

gmegan / specification

OpenSHMEM Application Programming Interface

http://www.openshmem.org

1 stars 0 forks source link

Overall document structure #11

Closed gmegan closed 6 years ago

gmegan commented 6 years ago

Where should the various teams API calls be placed in the overall document?

gmegan commented 6 years ago

It seems like the subsection with team split/destroy/my_pe/n_pes/get_options/translate should be located after memory management but before context creation. This is assuming we want to have shmem_ctx_get/set_team in the context section, so the description of teams comes before those API calls are described.

gmegan commented 6 years ago

The teams collectives are most similar to the active set based collectives. So the teams collectives could go in between the "all" collective call and the set collective call, e.g. 1 shmem_barrier_all 2 shmem_team_barrier 3 shmem_barrier

nspark commented 6 years ago

Suggest (from #20):

Rename section title from "Teams or PE Subsets" to "Team Management Routines" for general consistency
Move "Team Management Routines" section to precede "Communication Management Routines" section

gmegan commented 6 years ago

(from #20)

As per Naveens comment regarding the repeated text in the notes section of many API calls, the repeated information about default teams, and potentially other oft repeated text, should be moved up to the top of the Team Management Routines section and referenced where appropriate.

gmegan commented 6 years ago

Closing this issue. We can open a new issue if there are other requests for structure changes.