Skip to content

Commit

Permalink
First reading feedback:
Browse files Browse the repository at this point in the history
singular use of query vs queries in intro
permissable -> permissible
any keys -> any particular keys when describing what implementations must support
block of text that was accidentally not moved with the list of attributes that
  where moved.
similified -> simplified

Signed-off-by: dsolt@us.ibm.com
  • Loading branch information
dsolt committed May 24, 2022
1 parent 4580e39 commit 3499152
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions Chap_API_Query.tex
Expand Up @@ -7,7 +7,7 @@ \chapter{Query Operations}
This chapter presents mechanisms for generalized queries that
access information about the host environment and the system in general.
The chapter presents the concept of a query followed by a detailed explanation
of the queries \acp{API} provided. The chapter compares the use of these \acp{API} with \refapi{PMIx_Get}. The chapter concludes with detailed information about how to use
of the query \acp{API} provided. The chapter compares the use of these \acp{API} with \refapi{PMIx_Get}. The chapter concludes with detailed information about how to use
the query interface to access information about what \ac{PMIx} \acp{API} an implementation supports as well as what attributes each supported \ac{API} supports.

\section{PMIx_Query_info}
Expand All @@ -24,7 +24,7 @@ \subsection{Query Structure}
\declarestruct{pmix_query_t}

A \ac{PMIx} query structure is composed of one or more keys and a list of qualifiers which provide additional information to describe the query.
Keys which use the same qualifiers can be placed in the same query for compactness, though it is permissable to put each key in its own query.
Keys which use the same qualifiers can be placed in the same query for compactness, though it is permissible to put each key in its own query.

The \refstruct{pmix_query_t} structure is used by the \refapi{PMIx_Query_info} \acp{API} to describe a single query operation.

Expand Down Expand Up @@ -110,7 +110,7 @@ \subsection{\code{PMIx_Query_info}}
% Use of pmix_server_query_fn is covered in server interfaces chapter
\reqattrend

An implementation is not required to support any keys. If a key is unsupported, the implementation should handle that key in the same way that it is required to handle a key which it cannot find.
An implementation is not required to support any particular keys. If a key is unsupported, the implementation should handle that key in the same way that it is required to handle a key which it cannot find.
The following keys may be specified in a query:

\pasteAttributeItem{PMIX_QUERY_ATTRIBUTE_SUPPORT}
Expand Down Expand Up @@ -221,7 +221,7 @@ \subsection{\code{PMIx_Query_info_nb}}
% Use of pmix_server_query_fn is covered in server interfaces chapter
\reqattrend

An implementation is not required to support any keys. If a key is unsupported, the implementation should handle that key in the same way that it is required to handle a key which it cannot find.
An implementation is not required to support any particular keys. If a key is unsupported, the implementation should handle that key in the same way that it is required to handle a key which it cannot find.
The following keys may be specified in a query:

\pasteAttributeItem{PMIX_QUERY_ATTRIBUTE_SUPPORT}
Expand Down Expand Up @@ -357,9 +357,6 @@ \subsection{Query keys}
Average Megabytes of memory used by client processes on node. OPTIONAL QUALIFERS: \refattr{PMIX_HOSTNAME} or \refattr{PMIX_NODEID} (defaults to caller's node).
}

\vspace{\baselineskip}
The following attributes are used as qualifiers in queries regarding attribute support within the \ac{PMIx} implementation and/or the host environment:

\subsection{Query attributes}
\label{api:struct:attributes:query}

Expand Down Expand Up @@ -397,6 +394,8 @@ \subsection{Query attributes}
\declareAttributeNEW{PMIX_SERVER_INFO_ARRAY}{"pmix.srv.arr"}{pmix_data_array_t}{
Array of \refstruct{pmix_info_t} about a given server, starting with its \refattr{PMIX_NSPACE} and including at least one of the rendezvous-required pieces of information.
}
\vspace{\baselineskip}
The following attributes are used as qualifiers in queries regarding attribute support within the \ac{PMIx} implementation and/or the host environment:
%
\declareAttributeNEW{PMIX_CLIENT_FUNCTIONS}{"pmix.client.fns"}{bool}{
Request a list of functions supported by the \ac{PMIx} client library.
Expand Down Expand Up @@ -538,7 +537,7 @@ \subsubsection{Query structure support macros}
\section{\code{PMIx_Resolve_peers}}

There are a number of common queries for which \ac{PMIx} provides convenience routines.
These \acp{API} provide similified access to commonly requested queries. Due to their simplified interface, these \acp{API} cannot be customized through the use of attributes.
These \acp{API} provide simplified access to commonly requested queries. Due to their simplified interface, these \acp{API} cannot be customized through the use of attributes.
If a more specialized version of these queries are required, similar functionality can
often be accessed through the \refapi{PMIx_Query_info} or \refapi{PMIx_Query_info_nb} \acp{API}.

Expand Down

0 comments on commit 3499152

Please sign in to comment.