Skip to content

Commit

Permalink
Always have show-help text available
Browse files Browse the repository at this point in the history
Remove the generation (by Sphinx) of the show-help text
and just maintain it as text. Telling users show-help
isn't available just because Sphinx isn't around is
unfriendly - and we really don't get much benefit
from keeping show-help source in rst.

Signed-off-by: Ralph Castain <rhc@pmix.org>
(cherry picked from commit 772e1ac)
  • Loading branch information
rhc54 committed Sep 23, 2024
1 parent 546f41c commit bd64606
Show file tree
Hide file tree
Showing 61 changed files with 10,348 additions and 4,068 deletions.
1 change: 0 additions & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -1019,7 +1019,6 @@ AC_CONFIG_FILES([
include/prte_version.h
docs/Makefile
src/docs/Makefile
src/docs/show-help-files/Makefile
src/docs/prrte-rst-content/Makefile
])

Expand Down
47 changes: 44 additions & 3 deletions src/docs/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Copyright (c) 2022-2023 Cisco Systems, Inc. All rights reserved.
# Copyright (c) 2023 Jeffrey M. Squyres. All rights reserved.
# Copyright (c) 2023 Nanook Consulting. All rights reserved.
# Copyright (c) 2023-2024 Nanook Consulting All rights reserved.
#
# $COPYRIGHT$
#
Expand All @@ -10,6 +10,47 @@
# $HEADER$
#

dist_prtedata_DATA = \
show-help-files/help-cli.txt \
show-help-files/help-dash-host.txt \
show-help-files/help-errmgr-base.txt \
show-help-files/help-ess-base.txt \
show-help-files/help-hostfile.txt \
show-help-files/help-iof-base.txt \
show-help-files/help-oob-base.txt \
show-help-files/help-oob-tcp.txt \
show-help-files/help-plm-base.txt \
show-help-files/help-plm-slurm.txt \
show-help-files/help-plm-ssh.txt \
show-help-files/help-prte-filem-raw.txt \
show-help-files/help-prte-hwloc-base.txt \
show-help-files/help-prte-info.txt \
show-help-files/help-prte-odls-base.txt \
show-help-files/help-prte-odls-default.txt \
show-help-files/help-prte-rmaps-base.txt \
show-help-files/help-prte-rmaps-ppr.txt \
show-help-files/help-prte-rmaps-seq.txt \
show-help-files/help-prte-rtc-base.txt \
show-help-files/help-prte-rtc-hwloc.txt \
show-help-files/help-prte-runtime.txt \
show-help-files/help-prte-util.txt \
show-help-files/help-prte.txt \
show-help-files/help-prted.txt \
show-help-files/help-prterun.txt \
show-help-files/help-prun.txt \
show-help-files/help-psched.txt \
show-help-files/help-pterm.txt \
show-help-files/help-ras-base.txt \
show-help-files/help-ras-pbs.txt \
show-help-files/help-ras-simulator.txt \
show-help-files/help-ras-slurm.txt \
show-help-files/help-rmaps_rank_file.txt \
show-help-files/help-schizo-base.txt \
show-help-files/help-schizo-ompi.txt \
show-help-files/help-schizo-srun.txt \
show-help-files/help-state-base.txt



SUBDIRS = \
prrte-rst-content \
show-help-files
prrte-rst-content
3 changes: 0 additions & 3 deletions src/docs/show-help-files/.gitignore

This file was deleted.

121 changes: 0 additions & 121 deletions src/docs/show-help-files/Makefile.am

This file was deleted.

82 changes: 0 additions & 82 deletions src/docs/show-help-files/build-dummy-ini-files.py

This file was deleted.

1 change: 0 additions & 1 deletion src/docs/show-help-files/conf.py

This file was deleted.

Loading

0 comments on commit bd64606

Please sign in to comment.