addressing some errata from 1.2 voting period

spophale · Apr 7, 2015 · a2a5deb · a2a5deb
1 parent 62181c4
commit a2a5deb
Show file tree

Hide file tree

Showing 31 changed files with 47 additions and 27 deletions.
diff --git a/content/backmatter.tex b/content/backmatter.tex
@@ -409,11 +409,11 @@ \section{Version 1.2}
 \\See Section \ref{subsec:shmem_wait}.
 %
 \item Undefined behavior for null pointers without zero counts added.
-\\See Section \ref{sec:undefined}
+\\See Annex \ref{sec:undefined}
 %
 \item Addition of new Annex for clearly specifying deprecated API and its
       support in the existing specification version.
-\\See Section \ref{sec:dep_api}.
+\\See Annex \ref{sec:dep_api}.
 %
 \end{itemize}
 
@@ -425,7 +425,7 @@ \section{Version 1.1}
 1.0 to the Version 1.1.  A major change in this version is that it provides an
 accurate description of \openshmem interfaces so that they are in agreement with
 the SGI specification.  This version also explains \openshmem’s programming,
-memory, and execution model.  The document was throughly changed to improve the
+memory, and execution model.  The document was thoroughly changed to improve the
 readability of specification and usability of interfaces.  The code examples
 were added to demonstrate the usability of API. Additionally, diagrams were
 added to help understand the subtle semantic differences of various operations.

diff --git a/content/environment_variables.tex b/content/environment_variables.tex
@@ -8,7 +8,7 @@
 
 \begin{tabular}{|l|l|l|}
 \hline 
-Variable & Value & Routine\tabularnewline
+Variable & Value & Purpose\tabularnewline
 \hline 
 \hline 
 \texttt{SMA\_VERSION} & any & print the library version at

diff --git a/content/execution_model.tex b/content/execution_model.tex
@@ -23,7 +23,7 @@
 \openshmem calls (e.g. to specify \OPR{put} or \OPR{get} routines on symmetric
 data objects, collective synchronization calls) or to dictate a control flow for
 \ac{PE}s using constructs of \Clang{} or \Fortran. The identifiers are fixed for
-the life cycle of the \openshmem program.
+the life of the \openshmem program.
 
 \subsection{Progress of \openshmem Operations}\label{subsec:progress}
 

diff --git a/content/library_constants.tex b/content/library_constants.tex
@@ -25,7 +25,7 @@
 \hbox{\hspace*{12mm} \const{SHMEM\_SYNC\_VALUE}} 
 \hbox{\strut \Fortran:} 
 \hbox{\hspace*{12mm} \const{SHMEM\_SYNC\_VALUE}}} 
-& Holds the value used to initialize the elements of \VAR{pSync} arrays. The
+& The value used to initialize the elements of \VAR{pSync} arrays. The
 value of this constant is implementation specific.\tabularnewline
 \hline
 \vtop{\hbox{\CorCpp:} 
@@ -110,7 +110,8 @@
 \hbox{\strut \Fortran:} 
 \hbox{\hspace*{12mm} \const{SHMEM\_VENDOR\_STRING}}} 
 &
-String representing the string of length less than  \const{SHMEM\_MAX\_NAME\_LEN} . \tabularnewline
+String representing the vendor name of length less than
+\const{SHMEM\_MAX\_NAME\_LEN} . \tabularnewline
 \hline
 
 \end{tabular}

diff --git a/content/shmem_add.tex b/content/shmem_add.tex
@@ -39,7 +39,7 @@
 
 \apidesctable{
     If you are using \Fortran, \VAR{dest} must be of the following type:
-}{Routine}{Data type of \VAR{dest} and \VAR{source}}
+}{Routine}{Data type of \VAR{dest}}
 
 \apitablerow{SHMEM\_INT4\_ADD}{\CONST{4}-byte integer}
 \apitablerow{SHMEM\_INT8\_ADD}{\CONST{8}-byte integer}

diff --git a/content/shmem_cswap.tex b/content/shmem_cswap.tex
@@ -40,9 +40,9 @@
     atomic operation.   
 }
 \apidesctable{
-    The  \VAR{dest}  and source data objects must conform to certain typing
+    The  \VAR{dest} and \VAR{value} data objects must conform to certain typing
     constraints, which are as follows:
-}{Routine}{Data type of \VAR{dest} and \VAR{source}}
+}{Routine}{Data type of \VAR{dest} and \VAR{value}}
 
 \apitablerow{SHMEM\_INT4\_CSWAP}{\CONST{4}-byte integer.}
 \apitablerow{SHMEM\_INT8\_CSWAP}{\CONST{8}-byte integer.}

diff --git a/content/shmem_finalize.tex b/content/shmem_finalize.tex
@@ -11,7 +11,7 @@
 \end{Csynopsis}
 
 \begin{Fsynopsis}
-CALL SHMEM_FINALIZE
+CALL SHMEM_FINALIZE()
 \end{Fsynopsis}
 
 \begin{apiarguments}
@@ -24,7 +24,7 @@
     releases resources used by the \openshmem library. This collective
     operation requires all \acp{PE} to participate in the call. There is an
     implicit global barrier in \FUNC{shmem\_finalize} so that pending
-    communication is completed, and no resources can be released until all
+    communications are completed, and no resources can be released until all
     \acp{PE} have entered \FUNC{shmem\_finalize}. \FUNC{shmem\_finalize} must be
     the last \openshmem library call encountered in the \openshmem portion of a
     program. A call to \FUNC{shmem\_finalize} will release any resources

diff --git a/content/shmem_info_get_name.tex b/content/shmem_info_get_name.tex
@@ -9,8 +9,8 @@
 \end{Csynopsis}
 
 \begin{Fsynopsis}
-SHMEM_INFO_GET_NAME(NAME)   
 CHARACTER *(*)NAME
+SHMEM_INFO_GET_NAME(NAME)   
 \end{Fsynopsis}
 
 \begin{apiarguments}

diff --git a/content/shmem_info_get_version.tex b/content/shmem_info_get_version.tex
@@ -9,8 +9,8 @@
 \end{Csynopsis}
 
 \begin{Fsynopsis}
-SHMEM_INFO_GET_VERSION(MAJOR, MINOR)   
 INTEGER MAJOR, MINOR
+SHMEM_INFO_GET_VERSION(MAJOR, MINOR)   
 \end{Fsynopsis}
 
 \begin{apiarguments}

diff --git a/content/shmem_init.tex b/content/shmem_init.tex
@@ -23,7 +23,7 @@
     library. It is a collective operation that all \acp{PE} must call before any
     other \openshmem routine may be called. At the end of the \openshmem program
     which it initialized, the call to \FUNC{shmem\_init} must be matched with a
-    call to \FUNC{shmem\_finalize}. After a single call to \FUNC{shmem\_init}, a
+    call to \FUNC{shmem\_finalize}. After the first call to \FUNC{shmem\_init}, a
     subsequent call to \FUNC{shmem\_init} in the same program results in undefined
     behavior.
 }

diff --git a/content/shmem_malloc.tex b/content/shmem_malloc.tex
@@ -86,7 +86,7 @@
 }		
 
 \apiimpnotes{
-    The symmetric heap allocation functions always return a pointer to corresponding
+    The symmetric heap allocation routines always return a pointer to corresponding
     symmetric objects across all PEs. The \openshmem{} specification does not
     require that the virtual addresses are equal across all \acp{PE}. Nevertheless,
     the implementation must avoid costly address translation operations in the

diff --git a/content/shmem_pe_accessible.tex b/content/shmem_pe_accessible.tex
@@ -40,7 +40,7 @@
 }
 
 \apireturnvalues{
-    \Clang: The return value is 1 if the specified \ac{PE} is a valid remote \ac{PE}
+    \CorCpp: The return value is 1 if the specified \ac{PE} is a valid remote \ac{PE}
     for \openshmem routines; otherwise, it is 0. \\ \\
 
     \Fortran: The return value is \CONST{.TRUE.} if the specified \ac{PE} is a valid

diff --git a/content/shpalloc.tex b/content/shpalloc.tex
@@ -43,7 +43,7 @@
 }
 
 \apiimpnotes{
-    The symmetric heap allocation functions always return a pointer to corresponding
+    The symmetric heap allocation routines always return a pointer to corresponding
     symmetric objects across all PEs. The \openshmem{} specification does not
     require that the virtual addresses are equal across all \acp{PE}. Nevertheless,
     the implementation must avoid costly address translation operations in the

diff --git a/content/the_openshmem_effort.tex b/content/the_openshmem_effort.tex
@@ -8,8 +8,8 @@
 \openshmem library implementations to help the users write portable \openshmem
 code. This ensures that programs can run on multiple platforms without having to
 deal with subtle vendor-specific implementation differences. For more details on
-the history of \openshmem please refer to \hyperref[sec:openshmem_history]{The
-History of \openshmem} section.  
+the history of \openshmem please refer to the
+\hyperref[sec:openshmem_history]{History of \openshmem} section.  
 
 The \openshmem\footnote{The \openshmem specification is owned by Open Source
 Software Solutions Inc., a non-profit organization, under an agreement with

diff --git a/example_code/hello-openshmem.f90 b/example_code/hello-openshmem.f90
@@ -1,6 +1,6 @@
 program hello
 
-  include 'shmem.fh'
+  include "shmem.fh"
   integer :: shmem_my_pe, shmem_n_pes
 
   integer :: npes, me

diff --git a/example_code/shmem_broadcast_example.f90 b/example_code/shmem_broadcast_example.f90
@@ -1,3 +1,5 @@
+INCLUDE "shmem.fh"
+
 INTEGER PSYNC(SHMEM_BCAST_SYNC_SIZE)
 INTEGER DEST, SOURCE, NLONG, PE_ROOT, PE_START,
 &   LOGPE_STRIDE, PE_SIZE, PSYNC

diff --git a/example_code/shmem_collect_example.f90 b/example_code/shmem_collect_example.f90
@@ -1,3 +1,5 @@
+INCLUDE "shmem.fh"
+
 INTEGER PSYNC(SHMEM_COLLECT_SYNC_SIZE)
 DATA PSYNC /SHMEM_COLLECT_SYNC_SIZE*SHMEM_SYNC_VALUE/
 

diff --git a/example_code/shmem_get_example.f90 b/example_code/shmem_get_example.f90
@@ -1,4 +1,6 @@
 PROGRAM REDUCTION
+INCLUDE "shmem.fh"
+
 REAL VALUES, SUM
 COMMON /C/ VALUES
 REAL WORK

diff --git a/example_code/shmem_iget_example.f90 b/example_code/shmem_iget_example.f90
@@ -1,4 +1,6 @@
 PROGRAM STRIDELOGICAL
+INCLUDE "shmem.fh"
+
 LOGICAL SOURCE(10), DEST(5)
 SAVE SOURCE   ! SAVE MAKES IT REMOTELY ACCESSIBLE
 DATA SOURCE /.T.,.F.,.T.,.F.,.T.,.F.,.T.,.F.,.T.,.F./

diff --git a/example_code/shmem_init_example.f90 b/example_code/shmem_init_example.f90
@@ -1,4 +1,5 @@
 PROGRAM PUT
+INCLUDE "shmem.fh"
 
 INTEGER TARG, SRC, RECEIVER, BAR
 COMMON /T/ TARG

diff --git a/example_code/shmem_max_example.f90 b/example_code/shmem_max_example.f90
@@ -1,4 +1,5 @@
 INCLUDE "shmem.fh"
+
 INTEGER PSYNC(SHMEM_REDUCE_SYNC_SIZE)
 DATA PSYNC /SHMEM_REDUCE_SYNC_SIZE*SHMEM_SYNC_VALUE/
 PARAMETER (NR=1)

diff --git a/example_code/shmem_or_example.f90 b/example_code/shmem_or_example.f90
@@ -1,4 +1,4 @@
-INCLUDE "mpp/shmem.fh"
+INCLUDE "shmem.fh"
 
 INTEGER PSYNC(SHMEM_REDUCE_SYNC_SIZE)
 DATA PSYNC /SHMEM_REDUCE_SYNC_SIZE*SHMEM_SYNC_VALUE/

diff --git a/example_code/shmem_ptr_example.f90 b/example_code/shmem_ptr_example.f90
@@ -1,5 +1,5 @@
 PROGRAM REMOTEWRITE
-INCLUDE 'shmem.fh'
+INCLUDE "shmem.fh"
 
 INTEGER BIGD(100)
 SAVE BIGD

diff --git a/example_code/shmem_quiet_example.f90 b/example_code/shmem_quiet_example.f90
@@ -1,4 +1,6 @@
 PROGRAM COMPFLAG
+INCLUDE "shmem.fh"
+
 INTEGER FLAG_VAR, ARRAY(100), RECEIVER, SENDER
 COMMON/FLAG/FLAG_VAR
 COMMON/DATA/ARRAY

diff --git a/example_code/shmem_startpes_example.f90 b/example_code/shmem_startpes_example.f90
@@ -1,4 +1,5 @@
 PROGRAM PUT
+INCLUDE "shmem.fh"
 
 INTEGER TARG, SRC, RECEIVER, BAR
 COMMON /T/ TARG

diff --git a/example_code/shmem_wait1_example.f90 b/example_code/shmem_wait1_example.f90
@@ -1,2 +1,4 @@
+INCLUDE "shmem.fh"
+
 INTEGER*8 IVAR
 CALL SHMEM_INT8_WAIT(IVAR, INTEGER*8(100))
diff --git a/example_code/shmem_wait2_example.f90 b/example_code/shmem_wait2_example.f90
@@ -1,2 +1,4 @@
+INCLUDE "shmem.fh"
+
 INTEGER*8 IVAR
 CALL SHMEM_INT8_WAIT_UNTIL(IVAR, SHMEM_CMP_NE, INTEGER*8(100))
diff --git a/example_code/shmem_wait4_example.f90 b/example_code/shmem_wait4_example.f90
@@ -1,3 +1,5 @@
+INCLUDE "shmem.fh"
+
 SUBROUTINE EXAMPLE()
 INTEGER FLAG_VAR
 COMMON/FLAG/FLAG_VAR

diff --git a/example_code/shmem_xor_example.f90 b/example_code/shmem_xor_example.f90
@@ -1,4 +1,4 @@
-INCLUDE "mpp/shmem.fh"
+INCLUDE "shmem.fh"
 
 INTEGER PSYNC(SHMEM_REDUCE_SYNC_SIZE)
 DATA PSYNC /SHMEM_REDUCE_SYNC_SIZE*SHMEM_SYNC_VALUE/

diff --git a/main_spec.tex b/main_spec.tex
@@ -13,8 +13,6 @@
 
 
 
-\section*{Introduction}\label{sec:intro}
-
 \section{The \openshmem Effort}\label{subsec:openshmem_effort}
 \input{content/the_openshmem_effort}
 

diff --git a/utils/defs.tex b/utils/defs.tex
@@ -313,7 +313,9 @@
 \lstnewenvironment{Fsynopsis}
 { \textbf{FORTRAN:} 
   \lstset{language={Fortran}, backgroundcolor=\color{gray}, lineskip=3pt,
-  deletekeywords={TARGET,LEN}, aboveskip=0pt, belowskip=0pt}}{}
+  deletekeywords=[2]{STATUS},
+  deletekeywords=[3]{LOG}, aboveskip=0pt,
+  belowskip=0pt}}{}
 
 \newenvironment{apiarguments}{
 \newcommand{\apiargument}[3]{
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,8 +13,6 @@



		\section*{Introduction}\label{sec:intro}

		\section{The \openshmem Effort}\label{subsec:openshmem_effort}
		\input{content/the_openshmem_effort}

Expand Down