Mark provisional items as such

Signed-off-by: Joshua Hursey <[email protected]>

Chap_API_Data_Mgmt.tex

@@ -47,7 +47,7 @@ \section{Support Macros}
 
 %%%%
 \littleheader{Static initializer for the data buffer structure}
-\declaremacro{PMIX_DATA_BUFFER_STATIC_INIT}
+\declaremacroProvisional{PMIX_DATA_BUFFER_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_data_buffer_t} fields.
 
@@ -634,7 +634,7 @@ \subsection{\code{PMIx_Data_decompress}}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \subsection{\code{PMIx_Data_embed}}
-\declareapi{PMIx_Data_embed}
+\declareapiProvisional{PMIx_Data_embed}
 
 %%%%
 \summary

Chap_API_Fabric.tex

@@ -128,7 +128,7 @@ \subsection{Fabric endpoint support macros}
 
 %%%%
 \littleheader{Static initializer for the endpoint structure}
-\declaremacro{PMIX_ENDPOINT_STATIC_INIT}
+\declaremacroProvisional{PMIX_ENDPOINT_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_endpoint_t} fields.
 
@@ -243,7 +243,7 @@ \subsection{Fabric coordinate support macros}
 
 %%%%
 \littleheader{Static initializer for the coord structure}
-\declaremacro{PMIX_COORD_STATIC_INIT}
+\declaremacroProvisional{PMIX_COORD_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_coord_t} fields.
 
@@ -362,7 +362,7 @@ \subsection{Fabric geometry support macros}
 
 %%%%
 \littleheader{Static initializer for the geometry structure}
-\declaremacro{PMIX_GEOMETRY_STATIC_INIT}
+\declaremacroProvisional{PMIX_GEOMETRY_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_geometry_t} fields.
 
@@ -590,7 +590,7 @@ \subsection{Fabric registration structure}
 
 %%%%
 \subsubsection{Static initializer for the fabric structure}
-\declaremacro{PMIX_FABRIC_STATIC_INIT}
+\declaremacroProvisional{PMIX_FABRIC_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_fabric_t} fields.
 

Chap_API_Proc_Mgmt.tex

@@ -335,16 +335,16 @@ \subsection{Spawn-specific constants}
 \declareconstitemNEW{PMIX_ERR_JOB_FAILED_TO_LAUNCH}
 One or more processes in the job request failed to launch
 %
-\declareconstitemNEW{PMIX_ERR_JOB_EXE_NOT_FOUND}
+\declareconstitemProvisional{PMIX_ERR_JOB_EXE_NOT_FOUND}
 Specified executable not found
 %
-\declareconstitemNEW{PMIX_ERR_JOB_INSUFFICIENT_RESOURCES}
+\declareconstitemProvisional{PMIX_ERR_JOB_INSUFFICIENT_RESOURCES}
 Insufficient resources to spawn job
 %
-\declareconstitemNEW{PMIX_ERR_JOB_SYS_OP_FAILED}
+\declareconstitemProvisional{PMIX_ERR_JOB_SYS_OP_FAILED}
 System library operation failed
 %
-\declareconstitemNEW{PMIX_ERR_JOB_WDIR_NOT_FOUND}
+\declareconstitemProvisional{PMIX_ERR_JOB_WDIR_NOT_FOUND}
 Specified working directory not found
 %
 \end{constantdesc}
@@ -555,16 +555,16 @@ \subsection{Spawn attributes}
 Do not generate an event when this job normally terminates.
 }
 %
-\declareAttributeNEW{PMIX_ENVARS_HARVESTED}{"pmix.evar.hvstd"}{bool}{
+\declareAttributeProvisional{PMIX_ENVARS_HARVESTED}{"pmix.evar.hvstd"}{bool}{
 Environmental parameters have been harvested by the spawn requestor - the server
 does not need to harvest them.
 }
 %
-\declareAttributeNEW{PMIX_JOB_TIMEOUT}{"pmix.job.time"}{int}{
+\declareAttributeProvisional{PMIX_JOB_TIMEOUT}{"pmix.job.time"}{int}{
 Time in seconds before the spawned job should time out and be terminated (0 => infinite), defined as the total runtime of the job (equivalent to the walltime limit of typical batch schedulers).
 }
 %
-\declareAttributeNEW{PMIX_SPAWN_TIMEOUT}{"pmix.sp.time"}{int}{
+\declareAttributeProvisional{PMIX_SPAWN_TIMEOUT}{"pmix.sp.time"}{int}{
 Time in seconds before spawn operation should time out (0 => infinite).
 Logically equivalent to passing the \refattr{PMIX_TIMEOUT} attribute to the
 \refapi{PMIx_Spawn} \ac{API}, it is provided as a separate attribute to distinguish
@@ -633,7 +633,7 @@ \subsubsection{App structure support macros}
 
 %%%%
 \littleheader{Static initializer for the app structure}
-\declaremacro{PMIX_APP_STATIC_INIT}
+\declaremacroProvisional{PMIX_APP_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_app_t} fields.
 
@@ -1214,7 +1214,7 @@ \subsubsection{Topology support macros}
 
 %%%%
 \littleheader{Static initializer for the topology structure}
-\declaremacro{PMIX_TOPOLOGY_STATIC_INIT}
+\declaremacroProvisional{PMIX_TOPOLOGY_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_topology_t} fields.
 
@@ -1657,7 +1657,7 @@ \subsection{Device distance support macros}
 
 %%%%
 \littleheader{Static initializer for the device distance structure}
-\declaremacro{PMIX_DEVICE_DIST_STATIC_INIT}
+\declaremacroProvisional{PMIX_DEVICE_DIST_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_device_distance_t} fields.
 

Chap_API_Publish.tex

@@ -441,7 +441,7 @@ \subsubsection{Lookup data structure support macros}
 
 %%%%
 \littleheader{Static initializer for the pdata structure}
-\declaremacro{PMIX_LOOKUP_STATIC_INIT}
+\declaremacroProvisional{PMIX_LOOKUP_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_pdata_t} fields.
 

Chap_API_Reserved_Keys.tex

@@ -492,7 +492,7 @@ \subsection{Node realm keys}
 Number of processes in the specified job or application realm on the caller's node. Defaults to job realm unless the \refattr{PMIX_APP_INFO} and the \refattr{PMIX_APPNUM} qualifiers are given.
 }
 %
-\declareAttributeNEW{PMIX_NODE_OVERSUBSCRIBED}{"pmix.ndosub"}{bool}{
+\declareAttributeProvisional{PMIX_NODE_OVERSUBSCRIBED}{"pmix.ndosub"}{bool}{
 True if the number of processes from this job on this node exceeds the number of slots allocated to it
 }
 

Chap_API_Server.tex

@@ -236,7 +236,7 @@ \subsection{Server Initialization Attributes}
 The nodes comprising the session are homogeneous - i.e., they each contain the same number of identical packages, fabric interfaces, \acp{GPU}, and other devices.
 }
 %
-\declareAttributeNEW{PMIX_SINGLETON}{"pmix.singleton"}{char*}{
+\declareAttributeProvisional{PMIX_SINGLETON}{"pmix.singleton"}{char*}{
 String representation (nspace.rank) of proc ID for the singleton the server was started to support
 }
 
@@ -1469,7 +1469,7 @@ \subsubsection{Attribute registration structure support macros}
 
 %%%%
 \littleheader{Static initializer for the regattr structure}
-\declaremacro{PMIX_REGATTR_STATIC_INIT}
+\declaremacroProvisional{PMIX_REGATTR_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_regattr_t} fields.
 
@@ -1873,7 +1873,7 @@ \subsubsection{Cpuset support macros}
 
 %%%%
 \littleheader{Static initializer for the cpuset structure}
-\declaremacro{PMIX_CPUSET_STATIC_INIT}
+\declaremacroProvisional{PMIX_CPUSET_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_cpuset_t} fields.
 

Chap_API_Struct.tex

@@ -514,7 +514,7 @@ \subsubsection{Process structure support macros}
 
 %%%%
 \littleheader{Static initializer for the proc structure}
-\declaremacro{PMIX_PROC_STATIC_INIT}
+\declaremacroProvisional{PMIX_PROC_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_proc_t} fields.
 
@@ -868,7 +868,7 @@ \subsubsection{Process information structure support macros}
 
 %%%%
 \littleheader{Static initializer for the proc info structure}
-\declaremacro{PMIX_PROC_INFO_STATIC_INIT}
+\declaremacroProvisional{PMIX_PROC_INFO_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_proc_info_t} fields.
 
@@ -1070,7 +1070,7 @@ \subsubsection{Value structure support macros}
 
 %%%%
 \littleheader{Static initializer for the value structure}
-\declaremacro{PMIX_VALUE_STATIC_INIT}
+\declaremacroProvisional{PMIX_VALUE_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_value_t} fields.
 
@@ -1290,7 +1290,7 @@ \subsubsection{Info structure support macros}
 
 %%%%
 \littleheader{Static initializer for the info structure}
-\declaremacro{PMIX_INFO_STATIC_INIT}
+\declaremacroProvisional{PMIX_INFO_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_info_t} fields.
 
@@ -1764,7 +1764,7 @@ \subsubsection{Environmental variable support macros}
 
 %%%%
 \littleheader{Static initializer for the envar structure}
-\declaremacro{PMIX_ENVAR_STATIC_INIT}
+\declaremacroProvisional{PMIX_ENVAR_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_envar_t} fields.
 
@@ -1886,7 +1886,7 @@ \subsubsection{Byte object support macros}
 
 %%%%
 \littleheader{Static initializer for the byte object structure}
-\declaremacro{PMIX_BYTE_OBJECT_STATIC_INIT}
+\declaremacroProvisional{PMIX_BYTE_OBJECT_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_byte_object_t} fields.
 
@@ -2006,7 +2006,7 @@ \subsubsection{Data array support macros}
 
 %%%%
 \littleheader{Static initializer for the data array structure}
-\declaremacro{PMIX_DATA_ARRAY_STATIC_INIT}
+\declaremacroProvisional{PMIX_DATA_ARRAY_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_data_array_t} fields.
 

Chap_API_Sync_Access.tex

@@ -165,7 +165,7 @@ \subsection{Fence-related attributes}
 available to each participant at the end of the operation. By default, this will include all job-level information that was locally generated by \ac{PMIx} servers unless excluded using the \refattr{PMIX_COLLECT_GENERATED_JOB_INFO} attribute.
 }
 %
-\declareAttributeNEW{PMIX_LOCAL_COLLECTIVE_STATUS}{"pmix.loc.col.st"}{pmix_status_t}{
+\declareAttributeProvisional{PMIX_LOCAL_COLLECTIVE_STATUS}{"pmix.loc.col.st"}{pmix_status_t}{
 Status code for local collective operation being reported to the host by the server library. PMIx servers may aggregate the participation by local client processes in a collective operation - e.g., instead of passing individual client calls to \refapi{PMIx_Fence} up to the host environment, the server may pass only a single call to the host when all local participants have executed their \refapi{PMIx_Fence} call, thereby reducing the burden placed on the host. However, in cases where the operation locally fails (e.g., if a participating client abnormally terminates prior to calling the operation), the server upcall functions to the host do not include a \refstruct{pmix_status_t} by which the PMIx server can alert the host to that failure. This attribute resolves that problem by allowing the server to pass the status information regarding the local collective operation.
 }
 \advicermstart
@@ -895,7 +895,7 @@ \subsubsection{Query structure support macros}
 
 %%%%
 \littleheader{Static initializer for the query structure}
-\declaremacro{PMIX_QUERY_STATIC_INIT}
+\declaremacroProvisional{PMIX_QUERY_STATIC_INIT}
 
 Provide a static initializer for the \refstruct{pmix_query_t} fields.
 

Chap_API_Tools.tex

@@ -699,11 +699,11 @@ \subsection{IO Forwarding attributes}
 The following attributes are used to control \ac{IO} forwarding behavior at the request of tools. Use of the attributes is optional - any option not provided will revert to some implementation-specific value.
 
 %
-\declareAttributeNEW{PMIX_IOF_LOCAL_OUTPUT}{"pmix.iof.local"}{bool}{
+\declareAttributeProvisional{PMIX_IOF_LOCAL_OUTPUT}{"pmix.iof.local"}{bool}{
 Write output streams to local stdout/err
 }
 %
-\declareAttributeNEW{PMIX_IOF_MERGE_STDERR_STDOUT}{"pmix.iof.mrg"}{bool}{
+\declareAttributeProvisional{PMIX_IOF_MERGE_STDERR_STDOUT}{"pmix.iof.mrg"}{bool}{
 Merge stdout and stderr streams from application procs
 }
 %
@@ -727,7 +727,7 @@ \subsection{IO Forwarding attributes}
 Max time in seconds to buffer \ac{IO} before delivering it. Used in conjunction with buffering size, this prevents \ac{IO} from being held indefinitely while waiting for another payload to arrive.
 }
 %
-\declareAttributeNEW{PMIX_IOF_OUTPUT_RAW}{"pmix.iof.raw"}{bool}{
+\declareAttributeProvisional{PMIX_IOF_OUTPUT_RAW}{"pmix.iof.raw"}{bool}{
 Do not buffer output to be written as complete lines - output characters as the stream delivers them
 }
 %
@@ -743,7 +743,7 @@ \subsection{IO Forwarding attributes}
 Requests that output be marked with the time at which the data was received by the tool - note that this will differ from the time at which the data was collected from the source.
 }
 %
-\declareAttributeNEW{PMIX_IOF_RANK_OUTPUT}{"pmix.iof.rank"}{bool}{
+\declareAttributeProvisional{PMIX_IOF_RANK_OUTPUT}{"pmix.iof.rank"}{bool}{
 Tag output with the rank it came from
 }
 %
@@ -763,19 +763,19 @@ \subsection{IO Forwarding attributes}
 Requests that the host environment intercept the specified output stream(s) and deliver it to the requesting tool instead of its current final destination. This might be used, for example, during a debugging procedure to avoid injection of debugger-related output into the application’s results file. The original output stream(s) destination is restored upon termination of the tool.
 }
 %
-\declareAttributeNEW{PMIX_IOF_OUTPUT_TO_FILE}{"pmix.iof.file"}{char*}{
+\declareAttributeProvisional{PMIX_IOF_OUTPUT_TO_FILE}{"pmix.iof.file"}{char*}{
 Direct application output into files of form "<filename>.<nspace>.<rank>.stdout" (for \code{stdout}) and "<filename>.<nspace>.<rank>.stderr" (for \code{stderr}). If \refattr{PMIX_IOF_MERGE_STDERR_STDOUT} was given, then only the \code{stdout} file will be created and both streams will be written into it.
 }
 %
-\declareAttributeNEW{PMIX_IOF_OUTPUT_TO_DIRECTORY}{"pmix.iof.dir"}{char*}{
+\declareAttributeProvisional{PMIX_IOF_OUTPUT_TO_DIRECTORY}{"pmix.iof.dir"}{char*}{
 Direct application output into files of form "<directory>/<nspace>/rank.<rank>/stdout" (for \code{stdout}) and "<directory>/<nspace>/rank.<rank>/stderr" (for \code{stderr}). If \refattr{PMIX_IOF_MERGE_STDERR_STDOUT} was given, then only the \code{stdout} file will be created and both streams will be written into it.
 }
 %
-\declareAttributeNEW{PMIX_IOF_FILE_PATTERN}{"pmix.iof.fpt"}{bool}{
+\declareAttributeProvisional{PMIX_IOF_FILE_PATTERN}{"pmix.iof.fpt"}{bool}{
 Specified output file is to be treated as a pattern and not automatically annotated by nspace, rank, or other parameters. The pattern can use \code{\%n} for the namespace, and \code{\%r} for the rank wherever those quantities are to be placed. The resulting filename will be appended with ".stdout" for the \code{stdout} stream and ".stderr" for the \code{stderr} stream. If \refattr{PMIX_IOF_MERGE_STDERR_STDOUT} was given, then only the \code{stdout} file will be created and both streams will be written into it.
 }
 %
-\declareAttributeNEW{PMIX_IOF_FILE_ONLY}{"pmix.iof.fonly"}{bool}{
+\declareAttributeProvisional{PMIX_IOF_FILE_ONLY}{"pmix.iof.fonly"}{bool}{
 Output only into designated files - do not also output a copy to the console's stdout/stderr
 }
 %

pmix.sty

@@ -609,6 +609,10 @@
   \index[index_api]{#1|indexfmt} \label{apifn:#1}%
 }
 
+\newcommand{\declareapiProvisional}[1]{%
+  \index[index_api]{#1|indexfmt} \label{apifn:#1}\provisionalMarker{}%
+}
+
 \newcommand{\declareapiDEPNODISP}[1]{%
   \index[index_api]{Z_#1@#1!\textbf{(Deprecated)}|indexdepfmt} \label{apifn:#1}%
 }
@@ -647,6 +651,9 @@
 \newcommand{\declaremacro}[1]{%
   \index[index_macro]{#1|indexfmt} \label{macro:#1}%
 }
+\newcommand{\declaremacroProvisional}[1]{%
+  \index[index_macro]{#1|indexfmt} \label{macro:#1}\provisionalMarker{}%
+}
 
 \newcommand{\refmacro}[1]{\index[index_macro]{#1}\hyperref[macro:#1]{\code{#1}}}