Fix manpage formatting issues from code review

* Change Latex section references to manpage references * Remove extraneous tables from shmem_team_split_2d example * Remove dupliciate text from shmem_team_config_t * Remove unnecessary shmem_team_config_.3 file * Convert the Latex math notations to simple groff text * Fix "lth" and "kth" instances Signed-off-by: David Ozog <[email protected]>
lslusarczyk · Apr 2, 2021 · 0e5fd82 · 0e5fd82
1 parent 5a49e72
commit 0e5fd82
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 290 deletions.
diff --git a/man/shmem_alltoall.3 b/man/shmem_alltoall.3
@@ -284,18 +284,18 @@ must be passed by all PEs that participate in the collective.
 
 Given a PE 
 .I i
-that is the \kth PE
+that is the kth PE
 participating in the operation and a PE
 .I j
-that is the \lth PE
+that is the lth PE
 participating in the operation,
 
 PE 
 .I i
-sends the \lth block of its 
+sends the lth block of its
 .I source
 object to
-the \kth block of
+the kth block of
 the 
 .I dest
 object of PE 

diff --git a/man/shmem_alltoalls.3 b/man/shmem_alltoalls.3
@@ -295,21 +295,21 @@ that participate in the collective.
 
 Given a PE 
 .I i
-that is the \kth PE
+that is the kth PE
 participating in the operation and a PE
 .I j
-that is the \lth PE
+that is the lth PE
 participating in the operation
 PE 
 .I i
 sends the 
 .I sst
-*\lth block of the 
+* lth block of the
 .I source
 data object to
 the 
 .I dst
-*\kth block of the 
+* kth block of the
 .I dest
 data object on
 PE 

diff --git a/man/shmem_team_config_.3 b/man/shmem_team_config_.3
diff --git a/man/shmem_team_config_t.3 b/man/shmem_team_config_t.3
@@ -17,11 +17,11 @@ A structure type representing team configuration arguments
 .B typedef
 .B struct
 .I {
+
 .B int
 .I num_contexts
 
-
-.B shmem_team_config_t
+.I } shmem_team_config_t
 
 
 ./ sectionEnd
@@ -52,8 +52,11 @@ in existance at any given time. It is not a guaruntee that N
 calls to 
 .B shmem\_team\_create\_ctx
 will succeed.
-See Section~\ref{sec:ctx} for more on communication contexts and
-Section~\ref{subsec:shmem_team_create_ctx} for team-based context creation.
+See
+.B shmem\_ctx\_create
+for more on communication contexts and
+.B shmem\_team\_create\_ctx
+for team-based context creation.
 
 When using the configuration structure to create teams, a mask parameter
 controls which fields may be accessed by the OpenSHMEM library.
@@ -71,77 +74,9 @@ parameters.
 ./ sectionStart
 .TP 25
 SHMEM\_TEAM\_NUM\_CONTEXTS
-The team should be created using the value of the .I num\_contexts member of the configuration parameter .I config as a requirement. 
-./ sectionEnd
-
-
-The default values for configuration parameters are:
-./ sectionStart
-.TP 25
-.I num\_contexts = 0
-By default, no contexts can be created on a new team 
-./ sectionEnd
-
-
-./ sectionEnd
-
-
-
-./ sectionStart
-
-.SH DESCRIPTION
-.SS Arguments
-.BR "Csynopsis " -
-.I 
-int num_contexts;
-
-- Csynopsis
-
-
-None.
-./ sectionEnd
-
-
-A team configuration object is provided as an argument to
-.B shmem\_team\_split\_*
-routines.
-It specifies the requested capabilities of the team to be
-created.
-
-The 
+The team should be created using the value of the
 .I num\_contexts
-member specifies the total number of simultaneously
-existing contexts that the program requests to create from this team.
-These contexts may be created in any number of threads. Successful
-creation of a team configured with 
-.I num\_contexts
-of N means
-that the implementation will make a best effort to reserve enough
-resources to support N contexts created from the team
-in existance at any given time. It is not a guaruntee that N
-calls to 
-.B shmem\_team\_create\_ctx
-will succeed.
-See Section \ref{sec:ctx} for more on communication contexts and
-Section \ref{subsec:shmem_team_create_ctx} for team-based context creation.
-
-When using the configuration structure to create teams, a mask parameter
-controls which fields may be accessed by the OpenSHMEM library.
-Any configuration parameter value that is not indicated in the mask will be
-ignored, and the default value will be used instead.
-Therefore, a program must only set the fields for which it does not want the default value.
-
-A configuration mask is created through a bitwise OR operation of the
-following library constants.
-A configuration mask value of 0 indicates that the team
-should be created with the default values for all configuration
-parameters.
-./ sectionStart
-.TP 25
-SHMEM\_TEAM\_NUM\_CONTEXTS
-The team should be created using the value of the 
-.I num\_contexts
-member of the configuration parameter 
+member of the configuration parameter
 .I config
 as a requirement. 
 ./ sectionEnd
@@ -150,14 +85,9 @@ as a requirement.
 The default values for configuration parameters are:
 ./ sectionStart
 .TP 25
-
-.I num\_contexts
-= 0
+.I num\_contexts = 0
 By default, no contexts can be created on a new team 
 ./ sectionEnd
 
 
-}
-
-
-
+./ sectionEnd
diff --git a/man/shmem_team_create_ctx.3 b/man/shmem_team_create_ctx.3
@@ -80,7 +80,8 @@ The
 routine may be called any number of times
 to create multiple simultaneously existing contexts for the team. Programs
 should request the total number of simultaneous contexts to be created from
-the team during team creation. See Section~\ref{subsec:shmem_team_config_t}
+the team during team creation. See
+.B shmem\_team\_config\_t
 for more information on how to request contexts during team creation.
 
 A call to