Skip to content

Commit df31b6c

Browse files
Update the library technote to mention '--client-server-library' flag (#28504)
Make sure to mention the new `--client-server-library` flag in the library technote, and add a note mentioning that the default behavior of the `--library` flag in multi-locale compilation settings has changed. Future work will need to rewrite the sections about multi-locale libraries entirely, opting to instead use a new term such as "client-server library" in order to more strongly differentiate them. Reviewed by @DanilaFe. Thanks!
2 parents 70d760a + 98e01bf commit df31b6c

1 file changed

Lines changed: 23 additions & 9 deletions

File tree

doc/rst/technotes/libraries.rst

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -694,12 +694,19 @@ definitions of these functions.
694694
Using Your Library in Multilocale Settings
695695
==========================================
696696

697+
.. note::
698+
699+
In order to compile a multilocale library as described in the following
700+
sections, you must specify the flag ``--client-server-library``. The default
701+
behavior of ``--library`` for multilocale Chapel configurations has
702+
been changed in release 2.8 to produce a more conventional dynamic library.
703+
697704
Prerequisites
698705
-------------
699706

700-
Chapel also supports ``--library`` when ``CHPL_COMM != none``. We intend to
701-
support other settings in the future, see :ref:`Other Settings` in the
702-
:ref:`Multilocale Caveats` section for more information.
707+
Chapel also supports ``--client-server-library`` when ``CHPL_COMM != none``.
708+
We intend to support other settings in the future, see :ref:`Other Settings`
709+
in the :ref:`Multilocale Caveats` section for more information.
703710

704711
To compile a multilocale library, `ZeroMQ <https://zeromq.org/>`_ must be
705712
installed.
@@ -843,11 +850,12 @@ the environment variable :ref:`chpl-rt-masterip`.
843850
Debugging Issues with Multilocale Libraries
844851
-------------------------------------------
845852

846-
The ``chpl`` compiler provides a developer flag, ``--library-ml-debug``, which
847-
can be used to generate communication and underlying library implementation
848-
debugging output. It is useful for tracking down connection issues between the
849-
generated executable and the generated library and unlikely to be helpful when
850-
tracking down issues with an exported function's body.
853+
The ``chpl`` compiler provides a developer flag,
854+
``--client-server-library-debug``, which can be used to generate communication
855+
and underlying library implementation debugging output. It is useful for
856+
tracking down connection issues between the generated executable and the
857+
generated library and unlikely to be helpful when tracking down issues with
858+
an exported function's body.
851859

852860
Caveats
853861
=======
@@ -910,12 +918,18 @@ supported for these types. We may be able to support all intents in the future.
910918
Multilocale Caveats
911919
-------------------
912920

921+
.. note::
922+
923+
The following sections describe caveats about multilocale libraries
924+
compiled with the ``--client-server-library`` flag.
925+
913926
.. _Other Settings:
914927

915928
Other Settings
916929
~~~~~~~~~~~~~~
917930

918-
The following settings are not yet supported for ``--library`` compilation:
931+
The ``--client-server-library`` flag does not currently support the
932+
following settings:
919933

920934
- ``--no-local``
921935
- ``CHPL_COMM = none`` when ``CHPL_LAUNCHER != none``

0 commit comments

Comments
 (0)