Skip to content

Commit

Permalink
Include notes about submodules in docs
Browse files Browse the repository at this point in the history
The installation docs didn't mention that PMIx now
incorporates a submodule. Add appropriate words
about that so people realize they need to initialize
the submodule before trying to build a Git clone.

Signed-off-by: Ralph Castain <rhc@pmix.org>
  • Loading branch information
rhc54 committed Mar 5, 2024
1 parent 5d35310 commit a5e1c42
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/developers/autogen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,19 @@ shell startup files)::
# For csh/tcsh:
set AUTOMAKE_JOBS 4

.. important:: ``autogen.pl`` will fail and report an error if you
forgot to install the required submodule prior to running the
autogen script. You can either do this by adding the ``--recursive``
flag to your Git ``clone`` command, or by manually populating the
submodule by running:

.. code-block:: sh
shell$ git submodule update --init
prior to executing ``autogen.pl``.


.. important:: You generally need to run ``autogen.pl`` whenever the
top-level file ``configure.ac`` changes, or any files in the
``config/`` or ``<project>/config/`` directories change (these
Expand Down
6 changes: 6 additions & 0 deletions docs/installing-pmix/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ must then run:

.. code-block:: sh
shell$ git submodule update --init
shell$ ./autogen.pl
The ``submodule update`` is required as PMIx incorporates a submodule
to support its `autoconf` logic. You can, however, omit the explicit
submodule update step `if` you cloned the Git repository with the
``--recursive`` flag.

You will need very recent versions of GNU Autoconf, Automake, and
Libtool. If ``autogen.pl`` fails, read the :doc:`Developer's Guide
</developers/index>`. If anything else fails, read the
Expand Down

0 comments on commit a5e1c42

Please sign in to comment.