From 7ba005d427241a79f77e5256e4b268dc696e87ff Mon Sep 17 00:00:00 2001 From: Joshua Hursey Date: Wed, 27 Jul 2022 10:01:37 -0500 Subject: [PATCH 1/2] Fix provsional markers * The prior mechanism put the marker in the margin, but was not working consistently. So instead put them in-line by the provisional text. Signed-off-by: Joshua Hursey --- Chap_API_Storage.tex | 18 ++++++------------ pmix.sty | 29 +++++++++++++++++++++-------- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/Chap_API_Storage.tex b/Chap_API_Storage.tex index 499bac4c..61d21d50 100644 --- a/Chap_API_Storage.tex +++ b/Chap_API_Storage.tex @@ -1,11 +1,9 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Chapter: Storage support %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\chapter{Storage Support Definitions} +\provisionalChapter{Storage Support Definitions} \label{chap:api_storage} -\provisionalMarker{} - Distributed and parallel computing systems are increasingly embracing storage hierarchies to meet the diverse data management needs of applications and other systems software in a cost-effective manner. These hierarchies provide access to a number of distinct storage layers, with each potentially composed of different storage hardware (e.g., HDD, SSD, tape, PMEM), deployed at different locations (e.g., on-node, on-switch, on-site, WAN), and designed using different storage paradigms (e.g., file-based, object-based). Each of these systems offers unique performance and usage characteristics that storage system users should carefully consider to ensure the most efficient use of storage resources. @@ -14,12 +12,10 @@ \chapter{Storage Support Definitions} These attributes can be queried by applications, I/O libraries and middleware, and workflow systems to discover available storage resources and to inform on which resources are most suitable for different I/O workload requirements. %%%%%%%%%%% -\section{Storage support constants} - +\provisionalSection{Storage support constants} \declarestruct{pmix_storage_medium_t} -\provisionalMarker{} -The \refstruct{pmix_storage_medium_t} is a \code{uint64_t} type that defines a set of bit-mask flags for specifying different types of storage mediums. These can be bitwise OR'd together to accommodate storage systems that mix storage medium types. +The \refstruct{pmix_storage_medium_t}~\provisionalMarker{} is a \code{uint64_t} type that defines a set of bit-mask flags for specifying different types of storage mediums. These can be bitwise OR'd together to accommodate storage systems that mix storage medium types. \begin{constantdesc} % @@ -53,9 +49,8 @@ \section{Storage support constants} \adviceimplend \declarestruct{pmix_storage_accessibility_t} -\provisionalMarker{} -The \refstruct{pmix_storage_accessibility_t} is a \code{uint64_t} type that defines a set of bit-mask flags for specifying different levels of storage accessibility (i.e,. from where a storage system may be accessed). These can be bitwise OR'd together to accommodate storage systems that are accessibile in multiple ways. +The \refstruct{pmix_storage_accessibility_t}~\provisionalMarker{} is a \code{uint64_t} type that defines a set of bit-mask flags for specifying different levels of storage accessibility (i.e,. from where a storage system may be accessed). These can be bitwise OR'd together to accommodate storage systems that are accessibile in multiple ways. \begin{constantdesc} % @@ -80,9 +75,8 @@ \section{Storage support constants} \end{constantdesc} \declarestruct{pmix_storage_persistence_t} -\provisionalMarker{} -The \refstruct{pmix_storage_persistence_t} type specifies different levels of persistence for a particular storage system. +The \refstruct{pmix_storage_persistence_t}~\provisionalMarker{} type specifies different levels of persistence for a particular storage system. \begin{constantdesc} % @@ -129,7 +123,7 @@ \section{Storage support constants} %%%%%%%%%%% -\section{Storage support attributes} +\provisionalSection{Storage support attributes} \label{api:struct:attributes:pstrg} The following attributes may be returned in response to queries (e.g., \refapi{PMIx_Get} or \refapi{PMIx_Query_info}) made by processes or tools. diff --git a/pmix.sty b/pmix.sty index 68e1840d..83961d79 100644 --- a/pmix.sty +++ b/pmix.sty @@ -241,12 +241,25 @@ % PMIx Standard Process markers % % - Provisional items -% \provisionalMarker Add a provisional label to the margin -% \markProvisional Add a provisional label to the margin and highlight the provided text +% \provisionalMarker Add a provisional label +% \markProvisional Add a provisional label and highlight the provided text % +% Putting this in the margin is not consistently working. +% Instead put this marker in-line in the text. +%\newcommand{\provisionalMarker}[0]{% -14 +% \textInMargin{\small{\hl{\textit{Provisional}}}}% +%} \newcommand{\provisionalMarker}[0]{% -14 - \textInMargin{\small{\hl{\textit{Provisional}}}}% + \small{\hl{\textit{(Provisional)}}}% +} + +\newcommand{\provisionalChapter}[1]{% -14 + \chapter{#1 \small{\textit{(Provisional)}}}% +} + +\newcommand{\provisionalSection}[1]{% -14 + \section{#1 \small{\textit{(Provisional)}}}% } \newcommand{\markProvisional}[1]{% -14 @@ -441,7 +454,7 @@ } \newcommand{\declareconstitemProvisional}[1]{% - \item[\hl{\code{#1}}]\provisionalMarker{}% + \item[\hl{\code{#1}}] \provisionalMarker{}% \index[index_const]{#1|indexfmt} \label{const:#1}% \hspace{1em}% } @@ -493,7 +506,7 @@ } \newcommand{\declareEnvarProvisional}[2]{% - \hl{\code{#1}}\provisionalMarker{}% + \hl{\code{#1}} \provisionalMarker{}% \index[index_envars]{#1|indexfmt} \label{envar:#1}% \InternaldeclareEnvar{#1}{#2}% } @@ -552,7 +565,7 @@ } \newcommand{\declareAttributeProvisional}[4]{% - \hl{\code{#1} ~~\code{#2}~~(\code{#3})}\provisionalMarker{}% + \hl{\code{#1} ~~\code{#2}~~(\code{#3})} \provisionalMarker{}% \index[index_attribute]{#1|indexfmt} \label{attr:#1}% \InternaldeclareAttributeBody{#1}{#2}{#3}{#4}% } @@ -610,7 +623,7 @@ } \newcommand{\declareapiProvisional}[1]{% - \index[index_api]{#1|indexfmt} \label{apifn:#1}\provisionalMarker{}% + \index[index_api]{#1|indexfmt} \label{apifn:#1} \provisionalMarker{}% } \newcommand{\declareapiDEPNODISP}[1]{% @@ -652,7 +665,7 @@ \index[index_macro]{#1|indexfmt} \label{macro:#1}% } \newcommand{\declaremacroProvisional}[1]{% - \index[index_macro]{#1|indexfmt} \label{macro:#1}\provisionalMarker{}% + \index[index_macro]{#1|indexfmt} \label{macro:#1} \provisionalMarker{}% } \newcommand{\refmacro}[1]{\index[index_macro]{#1}\hyperref[macro:#1]{\code{#1}}} From 20a9245d39797748631b4a4fb705380f42f705d3 Mon Sep 17 00:00:00 2001 From: Joshua Hursey Date: Wed, 27 Jul 2022 10:06:05 -0500 Subject: [PATCH 2/2] VERSION: Prepare for the v4.2 release Signed-off-by: Joshua Hursey --- pmix-standard.tex | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pmix-standard.tex b/pmix-standard.tex index 6ce85ffc..ea3cf087 100644 --- a/pmix-standard.tex +++ b/pmix-standard.tex @@ -56,11 +56,12 @@ \setboolean{is_unofficial_draft}{true} % Text to appear in the footer on even-numbered pages: +% Release candidates are marked as an Unofficial Draft \ifthenelse{\boolean{is_unofficial_draft}} - {\newcommand{\VER}{4.1 (Draft)} + {\newcommand{\VER}{4.2dev0 (Draft)} \newcommand{\VERDATE}{\emph{Created on \today}} } - {\newcommand{\VER}{4.1} + {\newcommand{\VER}{4.2} \newcommand{\VERDATE}{Month Year} } \newcommand{\footerText}{PMIx Standard -- Version \VER{} -- \VERDATE}