Deprecated the --stream-buffering CLI option

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
openpmix · Sep 2, 2022 · 1a90bcd · 1a90bcd
1 parent 1207c64
commit 1a90bcd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/mca/schizo/ompi/help-schizo-ompi.txt b/src/mca/schizo/ompi/help-schizo-ompi.txt
@@ -137,8 +137,6 @@ Initiate an instance of the PMIx Reference RTE (PRRTE) DVM
    --set-cwd-to-session-dir          Set the working directory of the started processes to their session
                                      directory
    --show-progress                   Output a brief periodic report on launch progress
-   --stream-buffering <arg0>         Adjust buffering for stdout/stderr [0 unbuffered] [1 line buffered] [2
-                                     fully buffered]
    --wd <arg0>                       Synonym for --wdir
    --wdir <arg0>                     Set the working directory of the started processes
 -x <arg0>                            Export an environment variable, optionally specifying a value (e.g., "-x

diff --git a/src/mca/schizo/ompi/schizo_ompi.c b/src/mca/schizo/ompi/schizo_ompi.c
@@ -140,7 +140,6 @@ static struct option ompioptions[] = {
 
     /* output options */
     PMIX_OPTION_DEFINE(PRTE_CLI_OUTPUT, PMIX_ARG_REQD),
-    PMIX_OPTION_DEFINE("stream-buffering", PMIX_ARG_REQD),
 
     /* input options */
     PMIX_OPTION_DEFINE(PRTE_CLI_STDIN, PMIX_ARG_REQD),
@@ -235,6 +234,7 @@ static struct option ompioptions[] = {
     PMIX_OPTION_DEFINE("rankfile", PMIX_ARG_REQD),
     PMIX_OPTION_DEFINE("output-proctable", PMIX_ARG_REQD),
     PMIX_OPTION_DEFINE("debug", PMIX_ARG_NONE),
+    PMIX_OPTION_DEFINE("stream-buffering", PMIX_ARG_REQD),
 
     PMIX_OPTION_END
 };
@@ -1511,8 +1511,14 @@ static int parse_env(char **srcenv, char ***dstenv,
         pmix_setenv("OMPI_MCA_ompi_display_comm", "mpi_finalize", true, dstenv);
     }
 
+    /* --stream-buffering will be deprecated starting with Open MPI v5 */
     if (NULL != (opt = pmix_cmd_line_get_param(results, "stream-buffering"))) {
         uint16_t u16;
+        if (prte_schizo_ompi_component.warn_deprecations) {
+            pmix_show_help("help-schizo-base.txt", "deprecated-inform", true, "stream-buffering",
+                           "This CLI option will be deprecated starting in Open MPI v5. "
+                           "If you need this functionality use the Open MPI MCA option: ompi_stream_buffering");
+        }
         u16 = strtol(opt->values[0], NULL, 10);
         if (0 != u16 && 1 != u16 && 2 != u16) {
             /* bad value */