Skip to content

Commit 674f46c

Browse files
authored
Merge pull request #13144 from jsquyres/pr/help-files-as-c-code
Encode help-*.txt file contents into C source code
2 parents 593d8ac + d1bf286 commit 674f46c

File tree

57 files changed

+322
-464
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+322
-464
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ opal/tools/wrappers/opalCC-wrapper-data.txt
313313
opal/tools/wrappers/opal_wrapper
314314
opal/tools/wrappers/opal.pc
315315

316-
opal/util/show_help_lex.c
316+
opal/util/show_help_content.c
317317
opal/util/keyval/keyval_lex.c
318318

319319
test/monitoring/aggregate_profile.pl

ompi/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
# Copyright (c) 2018 FUJITSU LIMITED. All rights reserved.
2222
# Copyright (c) 2021 Amazon.com, Inc. or its affiliates. All Rights
2323
# reserved.
24+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
2425
# $COPYRIGHT$
2526
#
2627
# Additional copyrights may follow
@@ -153,7 +154,7 @@ lib@OMPI_LIBMPI_NAME@_la_LDFLAGS = \
153154
headers =
154155
noinst_LTLIBRARIES =
155156
include_HEADERS =
156-
dist_ompidata_DATA =
157+
EXTRA_DIST =
157158
lib@OMPI_LIBMPI_NAME@_la_SOURCES += $(headers)
158159

159160
# Conditionally install the header files

ompi/communicator/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# Copyright (c) 2014 Research Organization for Information Science
1616
# and Technology (RIST). All rights reserved.
1717
# Copyright (c) 2016 IBM Corporation. All rights reserved.
18+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1819
# $COPYRIGHT$
1920
#
2021
# Additional copyrights may follow
@@ -39,4 +40,4 @@ lib@OMPI_LIBMPI_NAME@_la_SOURCES += \
3940
communicator/ft/comm_ft.c communicator/ft/comm_ft_reliable_bcast.c communicator/ft/comm_ft_propagator.c communicator/ft/comm_ft_detector.c communicator/ft/comm_ft_revoke.c
4041
endif # WANT_FT_MPI
4142

42-
dist_ompidata_DATA += communicator/help-comm.txt
43+
EXTRA_DIST += communicator/help-comm.txt

ompi/dpm/Makefile.am

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#
33
# Copyright (c) 2015-2020 Intel, Inc. All rights reserved.
44
# Copyright (c) 2016 IBM Corporation. All rights reserved.
5+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
56
# $COPYRIGHT$
67
#
78
# Additional copyrights may follow
@@ -11,11 +12,10 @@
1112

1213
# This makefile.am does not stand on its own - it is included from ompi/Makefile.am
1314

14-
dist_ompidata_DATA += dpm/help-dpm.txt
15+
EXTRA_DIST += dpm/help-dpm.txt
1516

1617
headers += \
1718
dpm/dpm.h
1819

1920
lib@OMPI_LIBMPI_NAME@_la_SOURCES += \
2021
dpm/dpm.c
21-

ompi/errhandler/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
# All rights reserved.
1313
# Copyright (c) 2008 Cisco Systems, Inc. All rights reserved.
1414
# Copyright (c) 2016 IBM Corporation. All rights reserved.
15+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1516
# $COPYRIGHT$
1617
#
1718
# Additional copyrights may follow
@@ -21,7 +22,7 @@
2122

2223
# This makefile.am does not stand on its own - it is included from ompi/Makefile.am
2324

24-
dist_ompidata_DATA += errhandler/help-mpi-errors.txt
25+
EXTRA_DIST += errhandler/help-mpi-errors.txt
2526

2627
headers += \
2728
errhandler/errcode.h \

ompi/mca/bml/r2/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
# All rights reserved.
1010
# Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
1111
# Copyright (c) 2017 IBM Corporation. All rights reserved.
12+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1213
# $COPYRIGHT$
1314
#
1415
# Additional copyrights may follow
@@ -21,7 +22,7 @@ r2_sources = \
2122
bml_r2.h \
2223
bml_r2_component.c
2324

24-
dist_ompidata_DATA = help-mca-bml-r2.txt
25+
EXTRA_DIST = help-mca-bml-r2.txt
2526

2627
if MCA_BUILD_ompi_bml_r2_DSO
2728
component_noinst =

ompi/mca/coll/base/Makefile.am

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@
99
# University of Stuttgart. All rights reserved.
1010
# Copyright (c) 2004-2005 The Regents of the University of California.
1111
# All rights reserved.
12+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1213
# $COPYRIGHT$
1314
#
1415
# Additional copyrights may follow
1516
#
1617
# $HEADER$
1718
#
1819

19-
dist_ompidata_DATA = base/help-mca-coll-base.txt
20+
EXTRA_DIST = base/help-mca-coll-base.txt
2021

2122
headers += \
2223
base/base.h \
@@ -51,4 +52,3 @@ if WANT_FT_MPI
5152
libmca_coll_la_SOURCES += \
5253
base/coll_base_agree_noft.c
5354
endif # WANT_FT_MPI
54-

ompi/mca/coll/xhc/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
#
22
# Copyright (c) 2021-2024 Computer Architecture and VLSI Systems (CARV)
33
# Laboratory, ICS Forth. All rights reserved.
4+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
45
# $COPYRIGHT$
56
#
67
# Additional copyrights may follow
78
#
89
# $HEADER$
910
#
1011

11-
dist_opaldata_DATA = help-coll-xhc.txt
12+
EXTRA_DIST = help-coll-xhc.txt
1213

1314
sources = \
1415
coll_xhc.h \

ompi/mca/hook/base/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
#
22
# Copyright (c) 2017 IBM Corporation. All rights reserved.
3+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
34
# $COPYRIGHT$
45
#
56
# Additional copyrights may follow
67
#
78
# $HEADER$
89
#
910

10-
dist_ompidata_DATA = base/help-mca-hook-base.txt
11+
EXTRA_DIST = base/help-mca-hook-base.txt
1112

1213
headers += \
1314
base/base.h

ompi/mca/mtl/ofi/Makefile.am

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
# Copyright (c) 2020 Triad National Security, LLC. All rights
1111
# reserved.
1212
# Copyright (c) 2022 Amazon.com, Inc. or its affiliates. All Rights reserved.
13+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1314
# $COPYRIGHT$
1415
#
1516
# Additional copyrights may follow
@@ -18,15 +19,14 @@
1819
#
1920

2021
EXTRA_DIST = post_configure.sh \
22+
help-mtl-ofi.txt \
2123
$(generated_source_modules)
2224

2325
MAINTAINERCLEANFILES = \
2426
$(generated_sources)
2527

2628
AM_CPPFLAGS = $(mtl_ofi_CPPFLAGS)
2729

28-
dist_ompidata_DATA = help-mtl-ofi.txt
29-
3030
generated_source_modules = \
3131
mtl_ofi_send_opt.pm \
3232
mtl_ofi_isend_opt.pm \

ompi/mca/mtl/psm2/Makefile.am

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@
1313
# Copyright (c) 2015 Intel, Inc. All rights reserved
1414
# Copyright (c) 2017 Los Alamos National Security, LLC.
1515
# All rights reserved.
16-
#
16+
#
1717
# Copyright (c) 2017 IBM Corporation. All rights reserved.
18+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1819
# $COPYRIGHT$
1920
#
2021
# Additional copyrights may follow
2122
#
2223
# $HEADER$
2324
#
2425

25-
EXTRA_DIST = post_configure.sh
26+
EXTRA_DIST = \
27+
post_configure.sh \
28+
help-mtl-psm2.txt
2629

2730
AM_CPPFLAGS = $(mtl_psm2_CPPFLAGS)
2831

29-
dist_ompidata_DATA = help-mtl-psm2.txt
3032

3133
mtl_psm2_sources = \
3234
mtl_psm2.c \

ompi/mca/pml/ob1/Makefile.am

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@
1414
# Copyright (c) 2012 NVIDIA Corporation. All rights reserved.
1515
# Copyright (c) 2017 IBM Corporation. All rights reserved.
1616
# Copyright (c) 2022 Amazon.com, Inc. or its affiliates. All Rights reserved.
17+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1718
# $COPYRIGHT$
1819
#
1920
# Additional copyrights may follow
2021
#
2122
# $HEADER$
2223
#
2324

24-
dist_ompidata_DATA = \
25+
EXTRA_DIST = \
26+
post_configure.sh \
2527
help-mpi-pml-ob1.txt
2628

27-
EXTRA_DIST = post_configure.sh
28-
2929
ob1_sources = \
3030
pml_ob1.c \
3131
pml_ob1.h \

ompi/mpi/Makefile.am

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
# Copyright (c) 2006-2018 Cisco Systems, Inc. All rights reserved.
1313
# Copyright (c) 2015 Research Organization for Information Science
1414
# and Technology (RIST). All rights reserved.
15+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1516
# $COPYRIGHT$
1617
#
1718
# Additional copyrights may follow
1819
#
1920
# $HEADER$
2021
#
2122

22-
EXTRA_DIST = \
23-
mpi/fortran/configure-fortran-output-bottom.h
24-
25-
dist_ompidata_DATA += mpi/help-mpi-api.txt
23+
EXTRA_DIST += \
24+
mpi/fortran/configure-fortran-output-bottom.h \
25+
mpi/help-mpi-api.txt

ompi/mpiext/ftmpi/c/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# Copyright (c) 2016-2022 The University of Tennessee and The University
44
# of Tennessee Research Foundation. All rights
55
# reserved.
6+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
67
# $COPYRIGHT$
78
#
89
# Additional copyrights may follow
@@ -37,7 +38,7 @@ libmpiext_ftmpi_c_la_SOURCES = \
3738
libmpiext_ftmpi_c_la_LIBADD = \
3839
profile/libpmpiext_ftmpi_c.la
3940

40-
dist_ompidata_DATA = help-mpi-ft.txt
41+
EXTRA_DIST = help-mpi-ft.txt
4142

4243
ompidir = $(ompiincludedir)/mpiext/
4344
ompi_HEADERS = $(headers)

ompi/runtime/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
# Copyright (c) 2006-2015 Cisco Systems, Inc. All rights reserved.
1313
# Copyright (c) 2014-2019 Intel, Inc. All rights reserved.
1414
# Copyright (c) 2016 IBM Corporation. All rights reserved.
15+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1516
# $COPYRIGHT$
1617
#
1718
# Additional copyrights may follow
@@ -21,7 +22,7 @@
2122

2223
# This makefile.am does not stand on its own - it is included from ompi/Makefile.am
2324

24-
dist_ompidata_DATA += runtime/help-mpi-runtime.txt
25+
EXTRA_DIST += runtime/help-mpi-runtime.txt
2526

2627
headers += \
2728
runtime/mpiruntime.h \

ompi/tools/mpirun/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# Copyright (c) 2021-2022 Amazon.com, Inc. or its affiliates. All Rights reserved.
55
# Copyright (c) 2021 Nanook Consulting. All rights reserved.
66
# Copyright (c) 2022 Cisco Systems, Inc. All rights reserved
7+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
78
# $COPYRIGHT$
89
#
910
# Additional copyrights may follow
@@ -15,7 +16,7 @@ if OMPI_WANT_PRRTE
1516

1617
bin_PROGRAMS = mpirun
1718

18-
dist_ompidata_DATA = help-mpirun.txt
19+
EXTRA_DIST = help-mpirun.txt
1920

2021
mpirun_SOURCES = \
2122
main.c

opal/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# and Technology (RIST). All rights reserved.
1616
# Copyright (c) 2020-2022 Amazon.com, Inc. or its affiliates. All Rights reserved.
1717
# Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved.
18+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1819
# $COPYRIGHT$
1920
#
2021
# Additional copyrights may follow
@@ -69,7 +70,7 @@ lib@OPAL_LIB_NAME@_la_LDFLAGS = -version-info @libopen_pal_so_version@
6970

7071
# included subdirectory Makefile.am's and appended-to variables
7172
headers =
72-
dist_opaldata_DATA =
73+
EXTRA_DIST =
7374
lib@OPAL_LIB_NAME@_la_SOURCES += $(headers)
7475

7576
# Conditionally install the header files

opal/mca/accelerator/base/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
# Copyright (c) 2014 Intel, Inc. All rights reserved.
55
# Copyright (c) 2022 Amazon.com, Inc. or its affiliates.
66
# All Rights reserved.
7+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
78
# $COPYRIGHT$
89
#
910
# Additional copyrights may follow
1011
#
1112
# $HEADER$
1213
#
1314

14-
dist_opaldata_DATA = base/help-accelerator-base.txt
15+
EXTRA_DIST = base/help-accelerator-base.txt
1516

1617
headers += \
1718
base/base.h

opal/mca/accelerator/cuda/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# Copyright (c) 2017 IBM Corporation. All rights reserved.
44
# Copyright (c) 2022 Amazon.com, Inc. or its affiliates.
55
# All Rights reserved.
6+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
67
# $COPYRIGHT$
78
#
89
# Additional copyrights may follow
@@ -12,7 +13,7 @@
1213

1314

1415
AM_CPPFLAGS = $(common_cuda_CPPFLAGS)
15-
dist_opaldata_DATA = help-accelerator-cuda.txt
16+
EXTRA_DIST = help-accelerator-cuda.txt
1617
sources = \
1718
accelerator_cuda.h \
1819
accelerator_cuda_component.c \

opal/mca/allocator/bucket/Makefile.am

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@
1111
# All rights reserved.
1212
# Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
1313
# Copyright (c) 2017 IBM Corporation. All rights reserved.
14+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1415
# $COPYRIGHT$
1516
#
1617
# Additional copyrights may follow
1718
#
1819
# $HEADER$
1920
#
2021

21-
dist_opaldata_DATA = help-mca-allocator-bucket.txt
22+
EXTRA_DIST = help-mca-allocator-bucket.txt
2223

2324
sources = \
2425
allocator_bucket.c \
@@ -46,4 +47,3 @@ mca_allocator_bucket_la_LIBADD = $(top_builddir)/opal/lib@OPAL_LIB_NAME@.la
4647
noinst_LTLIBRARIES = $(component_noinst)
4748
libmca_allocator_bucket_la_SOURCES = $(sources)
4849
libmca_allocator_bucket_la_LDFLAGS = -module -avoid-version
49-

opal/mca/base/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
# All rights reserved.
1212
# Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
1313
# Copyright (c) 2020 Google LLC. All rights reserved.
14+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1415
# $COPYRIGHT$
1516
#
1617
# Additional copyrights may follow
@@ -26,7 +27,7 @@ AM_CPPFLAGS = \
2627

2728
noinst_LTLIBRARIES = libmca_base.la
2829

29-
dist_opaldata_DATA = help-mca-base.txt help-mca-var.txt
30+
EXTRA_DIST = help-mca-base.txt help-mca-var.txt
3031

3132
# Source code files
3233

opal/mca/btl/base/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@
1111
# All rights reserved.
1212
# Copyright (c) 2021 Triad National Security, LLC. All rights reserved.
1313
# Copyright (c) 2021 Google, LLC. All rights reserved.
14+
# Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
1415
# $COPYRIGHT$
1516
#
1617
# Additional copyrights may follow
1718
#
1819
# $HEADER$
1920
#
2021

21-
dist_opaldata_DATA = base/help-mpi-btl-base.txt
22+
EXTRA_DIST = base/help-mpi-btl-base.txt
2223

2324
headers += \
2425
base/base.h \

0 commit comments

Comments
 (0)