Skip to content

Commit

Permalink
Simplify explanation of compressing being implementation dependant + …
Browse files Browse the repository at this point in the history
…minor grammar issue

Signed-off-by: David Solt <[email protected]>
  • Loading branch information
dsolt committed Apr 11, 2024
1 parent a7240dd commit dd0acbb
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions Chap_API_Data_Mgmt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ \subsection{\code{PMIx_Data_pack}}
The buffer may have already contain packed data, in which case the new data is appended to the buffer.
Providing an unsupported type flag will likewise be reported as an error.

Note that packed packing data using a type that
Note that packing data using a type that
does not explicitly specifies its size may
may lose precision when unpacked
by a non-homogeneous recipient. The \refapi{PMIx_Data_pack} function will do its best to deal
Expand Down Expand Up @@ -246,7 +246,7 @@ \subsection{\code{PMIx_Data_unpack}}

\begin{arglist}
\argin{source}{Pointer to a \refstruct{pmix_proc_t} structure containing the description of the process that packed the provided buffer. A NULL value may be used to indicate that the source is based on the same \ac{PMIx} version as the caller.
i. The rank may be set to \refconst{PMIX_RANK_WILDCARD} as only the namespace is used to determine the packing version as all processes in a namespace are required to be using the same \ac{PMIx} version. (handle)}
i. The rank may be set to \refconst{PMIX_RANK_WILDCARD} as only the namespace is used to determine the packing version as all processes in a namespace are required to use the same \ac{PMIx} version. (handle)}
\argin{buffer}{A pointer to the buffer from which the value will be extracted. (handle)}
\arginout{dest}{A pointer to the memory location into which the data is to be stored. Note that these values will be stored contiguously in memory. For strings, this pointer must be to (char**) to provide a means of supporting multiple string operations. The unpack function will allocate memory for each string in the array, but the caller must provide adequate memory for the array of pointers. (\code{void*})}
\arginout{max_num_values}{The number of values to be unpacked. Upon completion, the parameter will be set to the actual number of values unpacked. In most cases, this should match the maximum number provided in the parameters, but in no case will it exceed the value of this parameter. Note that unpacking fewer values than are actually available will leave the buffer in an unpackable state and the function will return an error code to warn of this condition.(\code{int32_t})}
Expand Down Expand Up @@ -340,7 +340,7 @@ \subsection{\code{PMIx_Data_print}}

\begin{arglist}
\argout{output}{The address of a pointer into which the address of the resulting output is to be stored. (\code{char**})}
\argin{prefix}{String to be prepended to the resulting output (\code{const char*}
\argin{prefix}{String to be prepended to the resulting output (\code{const char*})}
\argin{src}{A pointer to the memory location of the data value to be printed (handle)}
\argin{type}{The type of the data value to be printed --- must be one of the PMIx defined data types. (\refstruct{pmix_data_type_t})}
\end{arglist}
Expand Down Expand Up @@ -536,9 +536,7 @@ \subsection{\code{PMIx_Data_compress}}
will be allocated if operation is successfully concluded. Caller
is responsible for release of the allocated region. The input
data block will remain unaltered.
The method of compressing data is implementation dependent.
Data compressed by one implementation should not be uncompressed by a different implementation unless
the documentation of the two implementations explicitly support doing so.
The method of compressing and uncompressing data is implementation dependent.

Note: the compress function will return \code{False} if the operation
would not result in a smaller data block.
Expand Down Expand Up @@ -586,8 +584,7 @@ \subsection{\code{PMIx_Data_decompress}}
will be allocated if operation is successfully concluded. Caller
is responsible for release of the allocated region. The input
data block will remain unaltered.
Data compressed by one implementation should not be uncompressed by a different implementation unless
the documentation of the two implementations explicitly support doing so.
The method of compressing and uncompressing data is implementation dependent.

Only data compressed by the \refapi{PMIx_Data_compress} \ac{API}
can be decompressed by this function. Passing data that has not
Expand Down

0 comments on commit dd0acbb

Please sign in to comment.