Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenSHMEM 1.4 DocEdits #4

Merged
merged 4 commits into from
Dec 14, 2017
Merged

OpenSHMEM 1.4 DocEdits #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f4c794
Edits to drafts/osh-1.4-rc5 to facillitate manpage generation
angelali4096 Dec 4, 2017
fda5c5b
Rename shpdealloc -> shpdeallc for consistency
Dec 12, 2017
d086870
Update type support changelog entry to ref tables
Dec 12, 2017
5cd89b5
Update type support mention in changelog intro
Dec 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions content/backmatter.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,9 +375,9 @@ \section{Overview}\label{subsec:dep_overview}
\EnvVarRef{SMA\_DEBUG} & 1.4 & Current & \hyperref[subsec:environment_variables]{\VAR{SHMEM\_DEBUG}} \\ \hline
\minitab{\CorCpp: \FuncRef{shmem\_wait}
\\ \CorCpp: \FuncRef{shmem\_\FuncParam{TYPENAME}\_wait}}
& 1.4 & Current & See \textbf{Notes} for \hyperref[subsec:shmem_wait]{\FUNC{shmem\_wait\_until}} \\ \hline
& 1.4 & Current & See \textbf{Notes} for \hyperref[subsec:shmem_wait_until]{\FUNC{shmem\_wait\_until}} \\ \hline
\CorCpp: \FuncRef{shmem\_wait\_until} & 1.4 & Current
& \Cstd[11]: \hyperref[subsec:shmem_wait]{\FUNC{shmem\_wait\_until}}, \CorCpp: \hyperref[subsec:shmem_wait]{\FUNC{shmem\_long\_wait\_until}} \\ \hline
& \Cstd[11]: \hyperref[subsec:shmem_wait_until]{\FUNC{shmem\_wait\_until}}, \CorCpp: \hyperref[subsec:shmem_wait_until]{\FUNC{shmem\_long\_wait\_until}} \\ \hline
\minitab{\Cstd[11]: \FuncRef{shmem\_fetch}
\\ \CorCpp: \FuncRef{shmem\_\FuncParam{TYPENAME}\_fetch}}
& 1.4 & Current & \hyperref[subsec:shmem_atomic_fetch]{\FUNC{shmem\_atomic\_fetch}} \\ \hline
Expand Down Expand Up @@ -555,7 +555,7 @@ \section{Version 1.4}
\emph{contexts} for communication management,
\FUNC{shmem\_sync},
\FUNC{shmem\_calloc},
expanded type support for \ac{RMA} and \ac{AMO} operations,
expanded type support,
a new namespace for atomic operations,
atomic bitwise operations,
\FUNC{shmem\_test} for nonblocking point-to-point synchronization,
Expand Down Expand Up @@ -588,13 +588,13 @@ \section{Version 1.4}
\\See Section \ref{subsec:library_constants}.
%
\item Added type-generic interfaces for \FUNC{shmem\_wait\_until}.
\\ See Section \ref{subsec:shmem_wait}.
\\ See Section \ref{subsec:shmem_wait_until}.
%
\item Removed the \VAR{volatile} qualifiers from the \VAR{ivar} arguments to
\FUNC{shmem\_wait} routines and the \VAR{lock} arguments in the lock API.
\emph{Rationale: Volatile qualifiers were added to several API routines in
\openshmem[1.3]; however, they were later found to be unnecessary.}
\\ See Sections \ref{subsec:shmem_wait} and \ref{subsec:shmem_lock}.
\\ See Sections \ref{subsec:shmem_wait_until} and \ref{subsec:shmem_lock}.
%
\item Deprecated the \VAR{SMA\_}* environment variables and added equivalent
\VAR{SHMEM\_}* environment variables.
Expand Down Expand Up @@ -644,7 +644,7 @@ \section{Version 1.4}
%
\item Revised the description of \FUNC{shmem\_wait} for a multithreaded
\openshmem \ac{PE}.
\\See Section \ref{subsec:shmem_wait}
\\See Section \ref{subsec:shmem_wait_until}
%
\item Clarified description for \CONST{SHMEM\_VENDOR\_STRING}.
\\See Section \ref{subsec:library_constants}.
Expand All @@ -655,8 +655,10 @@ \section{Version 1.4}
\item Clarified API description for \FUNC{shmem\_info\_get\_name}.
\\See Section \ref{subsec:shmem_info_get_name}.
%
\item Expanded the type support for RMA and AMO operations.
\\ See Sections \ref{sec:rma} and \ref{sec:amo}.
\item Expanded the type support for RMA, AMO, and point-to-point
synchronization operations.
\\ See Tables \ref{stdrmatypes}, \ref{stdamotypes}, \ref{extamotypes}, and
\ref{p2psynctypes}
%
\item Renamed AMO operations to use \FUNC{shmem\_atomic\_*} prefix and
deprecated old AMO routines.
Expand Down Expand Up @@ -725,7 +727,7 @@ \section{Version 1.3}
%
\item Added \CTYPE{volatile} to remotely accessible pointer argument in
\FUNC{SHMEM\_WAIT} and \FUNC{SHMEM\_LOCK}.
\\See Sections \ref{subsec:shmem_wait} and \ref{subsec:shmem_lock}.
\\See Sections \ref{subsec:shmem_wait_until} and \ref{subsec:shmem_lock}.
%
\item Deprecation of \FUNC{SHMEM\_CACHE}.
\\See Section \ref{subsec:shmem_cache}.
Expand Down Expand Up @@ -791,7 +793,7 @@ \section{Version 1.2}
\\See Section \ref{subsec:shmem_put}.
%
\item Clarification related to \FUNC{shmem\_wait}.
\\See Section \ref{subsec:shmem_wait}.
\\See Section \ref{subsec:shmem_wait_until}.
%
\item Undefined behavior for null pointers without zero counts added.
\\See Annex \ref{sec:undefined}
Expand Down Expand Up @@ -851,7 +853,7 @@ \section{Version 1.1}
%
\item Clarification of the naming conventions for constant in \Cstd and
\Fortran.
\\See Section \ref{subsec:library_constants} and \ref{subsec:shmem_wait}.
\\See Section \ref{subsec:library_constants} and \ref{subsec:shmem_wait_until}.
%
\item Added \ac{API} calls: \FUNC{shmem\_char\_p}, \FUNC{shmem\_char\_g}.
\\See Sections \ref{subsec:shmem_p} and \ref{subsec:shmem_g}.
Expand Down Expand Up @@ -908,7 +910,7 @@ \section{Version 1.1}
\\See Sections \ref{subsec:shfree} and Annex \ref{sec:undefined}.
%
\item \Fortran programming fixes for examples.\\ See Sections
\ref{subsec:shmem_reductions} and \ref{subsec:shmem_wait}.
\ref{subsec:shmem_reductions} and \ref{subsec:shmem_wait_until}.
%
\item Clarifications of the reuse \VAR{pSync} and \VAR{pWork} across
collectives.
Expand Down
8 changes: 4 additions & 4 deletions content/shmem_reductions.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,11 +219,11 @@
}


{

\deprecationstart
\apidesctable{
When calling from \Fortran, the \dest{} date types are as follows:
}{Routine}{Data type}{
}{Routine}{Data type}
\apitablerow{shmem\_int8\_and\_to\_all}{Integer, with an element size of 8 bytes.}
\apitablerow{shmem\_int4\_and\_to\_all}{Integer, with an element size of 4 bytes.}
\apitablerow{shmem\_comp8\_max\_to\_all}{Complex, with an element size equal to two 8-byte real values.}
Expand Down Expand Up @@ -254,9 +254,9 @@
\apitablerow{shmem\_int4\_or\_to\_all}{Integer, with an element size of 4 bytes.}
\apitablerow{shmem\_int8\_xor\_to\_all}{Integer, with an element size of 8 bytes.}
\apitablerow{shmem\_int4\_xor\_to\_all}{Integer, with an element size of 4 bytes.}
}

\deprecationend
}


\apireturnvalues{
None.
Expand Down
0 content/shmem_wait.tex → content/shmem_wait_until.tex
View file
Open in desktop
File renamed without changes.
0 content/shpdealloc.tex → content/shpdeallc.tex
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions main_spec.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ \subsubsection{\textbf{SHPALLOC}}\label{subsec:shpalloc}
\subsubsection{\textbf{SHPCLMOVE}}\label{subsec:shpclmove}
\input{content/shpclmove.tex}

\subsubsection{\textbf{SHPDEALLC}}\label{subsec:shpdealloc}
\input{content/shpdealloc.tex}
\subsubsection{\textbf{SHPDEALLC}}\label{subsec:shpdeallc}
\input{content/shpdeallc.tex}


\subsection{Communication Management Routines}
Expand Down Expand Up @@ -275,8 +275,8 @@ \subsubsection{\textbf{SHMEM\_ALLTOALLS}}\label{subsec:shmem_alltoalls}
\subsection{Point-To-Point Synchronization Routines}\label{subsec:p2p_intro}
\input{content/p2p_sync_intro.tex}

\subsubsection{\textbf{SHMEM\_WAIT\_UNTIL}}\label{subsec:shmem_wait}
\input{content/shmem_wait.tex}
\subsubsection{\textbf{SHMEM\_WAIT\_UNTIL}}\label{subsec:shmem_wait_until}
\input{content/shmem_wait_until.tex}

\subsubsection{\textbf{SHMEM\_TEST}}\label{subsec:shmem_test}
\input{content/shmem_test.tex}
Expand Down