Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clairfy docs regarding installed chapel and chplconfig #25987

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Clairfy docs regarding installed chapel and chplconfig #25987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions doc/rst/usingchapel/building.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,11 @@ Chapel can be built and installed to a specific location as follows:
make
make install

Running ``./configure`` will save your current configuration of
``$CHPL_`` settings into a ``chplconfig`` file. Running it with the
``--prefix`` or ``--chpl-home`` options permits you to specify where
and how Chapel should be installed during the ``make install`` step.
Specifically:
Running ``./configure`` will save your current configuration of ``$CHPL_``
settings into a ``chplconfig`` file. This ``chplconfig`` file will be installed
wherever ``CHPL_HOME`` is. Running ``./configure`` with the ``--prefix`` or
``--chpl-home`` options permits you to specify where and how Chapel should be
installed during the ``make install`` step. Specifically:

* ``--prefix=/dir/for/install/`` causes the Chapel compiler,
libraries, and supporting code to be installed into the directories:
Expand All @@ -131,10 +131,11 @@ Specifically:
``/usr/local/`` or ``~/``. Note that elevated privileges are likely
to be required for any system-wide installation locations.

Please note that for any prefix-installed version of Chapel, the
meaning of ``$CHPL_HOME`` (e.g., as printed by compiler messages)
typically refers to ``/dir/for/install/share/chapel/x.yz`` where
``x.yz`` is the Chapel version that was installed.
Please note that for any prefix-installed version of Chapel, the meaning of
``$CHPL_HOME`` (e.g., as printed by compiler messages) is the path printed by
``chpl --print-chpl-home``. This is typically
``/dir/for/install/share/chapel/x.yz`` where ``x.yz`` is the Chapel version
that was installed.

* ``--chpl-home=/dir/for/install`` copies key files and directories
from the Chapel source tree into ``/dir/for/install``, preserving
Expand Down
15 changes: 11 additions & 4 deletions doc/rst/usingchapel/chplenv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1080,15 +1080,22 @@ Chapel configuration file is found, the definitions of that file are used.
The ``$CHPL_CONFIG`` variable is the path to the *enclosing*
directory - not the full path including ``chplconfig`` itself.

.. note::

In a prefix install, a ``chplconfig`` file is installed in ``$CHPL_HOME``.
See :ref:`readme-installing`.

Variable Priority
~~~~~~~~~~~~~~~~~

Variable precedence goes in the following order:

1. Explicit compiler flags: ``chpl --env=value``
2. Environment variables: ``CHPL_ENV=value``
3. Chapel configuration file: ``~/.chplconfig``
4. Inferred environment variables: ``printchplenv``
1. Explicit compiler flags specified as ``chpl --env=value```
2. Environment variables set by the user (``export CHPL_ENV=value`` or
``CHPL_ENV=value chpl ...``)
3. Chapel configuration file settings from a ``chplconfig`` file, as described
above
4. Inferred environment variables from ``printchplenv``


.. |trade| unicode:: U+02122 .. TRADE MARK SIGN