Skip to content

Commit

Permalink
Correct confusion over help file names
Browse files Browse the repository at this point in the history
Got renamed to "help-schizo-xxx", but still referenced by "help-xxx"
in some places, so let's revert back to the original "help-xxx"
syntax as the tools being referenced have nothing to do with
the schizo framework.

Signed-off-by: Ralph Castain <rhc@pmix.org>
(cherry picked from commit 15fe0b5)
  • Loading branch information
rhc54 committed Sep 27, 2023
1 parent 0469d17 commit f222dc9
Show file tree
Hide file tree
Showing 16 changed files with 27 additions and 893 deletions.
1 change: 1 addition & 0 deletions docs/news/news-v3.x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ series, in reverse chronological order.
continue to improve and correct the documents in future
releases.

- PR #1816: Correct confusion over help file names
- PR #1814: Update NEWS infrastructure
- PR #1810: Blacklist the HWLOC GL component to avoid deadlock
- PR #1807: Multiple commits
Expand Down
24 changes: 12 additions & 12 deletions src/docs/show-help-files/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,25 @@ SPHINX_OPTS ?= --keep-going -j auto
RST_SOURCE_FILES = \
$(srcdir)/prrte-rst-content/*.rst \
$(srcdir)/index.rst \
$(srcdir)/help-schizo-pinfo.rst \
$(srcdir)/help-schizo-prte.rst \
$(srcdir)/help-schizo-prted.rst \
$(srcdir)/help-schizo-prterun.rst \
$(srcdir)/help-schizo-prun.rst \
$(srcdir)/help-schizo-pterm.rst
$(srcdir)/help-prte-info.rst \
$(srcdir)/help-prte.rst \
$(srcdir)/help-prted.rst \
$(srcdir)/help-prterun.rst \
$(srcdir)/help-prun.rst \
$(srcdir)/help-pterm.rst

TXT_OUTDIR = $(OUTDIR)/text

# These files are the ones that are built that we care about (Sphinx
# will emit lots of files in the TXT_OUTDIR; these are the only ones
# that we care about).
ALL_TXT_BUILT = \
$(TXT_OUTDIR)/help-schizo-pinfo.txt \
$(TXT_OUTDIR)/help-schizo-prte.txt \
$(TXT_OUTDIR)/help-schizo-prted.txt \
$(TXT_OUTDIR)/help-schizo-prterun.txt \
$(TXT_OUTDIR)/help-schizo-prun.txt \
$(TXT_OUTDIR)/help-schizo-pterm.txt
$(TXT_OUTDIR)/help-prte-info.txt \
$(TXT_OUTDIR)/help-prte.txt \
$(TXT_OUTDIR)/help-prted.txt \
$(TXT_OUTDIR)/help-prterun.txt \
$(TXT_OUTDIR)/help-prun.txt \
$(TXT_OUTDIR)/help-pterm.txt

#-------------------

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 6 additions & 6 deletions src/docs/show-help-files/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ harmelss by-products; we ignore them.

.. toctree::

Pinfo <help-schizo-pinfo>
Pinfo <help-prte-info>

Prte <help-schizo-prte>
Prte <help-prte>

Prted <help-schizo-prted>
Prted <help-prted>

Prterun <help-schizo-prterun>
Prterun <help-prterun>

Prun <help-schizo-prun>
Prun <help-prun>

Prun <help-schizo-pterm>
Prun <help-pterm>

Have to also include these additional files so that Sphinx doesn't
complain that there are RST files in the doc tree that aren't used.
Expand Down
12 changes: 6 additions & 6 deletions src/mca/schizo/prte/schizo_prte.c
Original file line number Diff line number Diff line change
Expand Up @@ -462,27 +462,27 @@ static int parse_cli(char **argv, pmix_cli_result_t *results,
if (0 == strcmp(prte_tool_actual, "prte")) {
myoptions = prteoptions;
shorts = prteshorts;
helpfile = "help-schizo-prte.txt";
helpfile = "help-prte.txt";
} else if (0 == strcmp(prte_tool_actual, "prterun")) {
myoptions = prterunoptions;
shorts = prterunshorts;
helpfile = "help-schizo-prterun.txt";
helpfile = "help-prterun.txt";
} else if (0 == strcmp(prte_tool_actual, "prted")) {
myoptions = prtedoptions;
shorts = prtedshorts;
helpfile = "help-schizo-prted.txt";
helpfile = "help-prted.txt";
} else if (0 == strcmp(prte_tool_actual, "prun")) {
myoptions = prunoptions;
shorts = prunshorts;
helpfile = "help-schizo-prun.txt";
helpfile = "help-prun.txt";
} else if (0 == strcmp(prte_tool_actual, "pterm")) {
myoptions = ptermoptions;
shorts = ptermshorts;
helpfile = "help-schizo-pterm.txt";
helpfile = "help-pterm.txt";
} else if (0 == strcmp(prte_tool_actual, "prte_info")) {
myoptions = pinfooptions;
shorts = pinfoshorts;
helpfile = "help-schizo-pinfo.txt";
helpfile = "help-prte-info.txt";
}
pmix_tool_msg = "Report bugs to: https://github.com/openpmix/prrte";
pmix_tool_org = "PRRTE";
Expand Down
2 changes: 0 additions & 2 deletions src/tools/prte_info/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ AM_LDFLAGS = $(prte_hwloc_LDFLAGS) $(prte_libevent_LDFLAGS) $(prte_pmix_LDFLAGS)

bin_PROGRAMS = prte_info

dist_prtedata_DATA = help-prte-info.txt

prte_info_SOURCES = \
pinfo.h \
prte_info.c \
Expand Down
99 changes: 0 additions & 99 deletions src/tools/prte_info/help-prte-info.txt

This file was deleted.

4 changes: 1 addition & 3 deletions src/tools/prun/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# Copyright (c) 2015-2020 Intel, Inc. All rights reserved.
# Copyright (c) 2019 Research Organization for Information Science
# and Technology (RIST). All rights reserved.
# Copyright (c) 2021-2022 Nanook Consulting. All rights reserved.
# Copyright (c) 2021-2023 Nanook Consulting. All rights reserved.
# $COPYRIGHT$
#
# Additional copyrights may follow
Expand All @@ -41,8 +41,6 @@ AM_CFLAGS = \

bin_PROGRAMS = prun

dist_prtedata_DATA = help-prun.txt

prun_SOURCES = \
main.c \
prun.c \
Expand Down
Loading

0 comments on commit f222dc9

Please sign in to comment.