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.

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

Add two env variables in the documentation #2017

Merged
merged 2 commits into from
Mar 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 0 additions & 3 deletions arcane/doc/doc_dev/0_devmanual.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@

\image html cea_ifpen_logo.png "Logo du CEA et logo de l'IFPEN"

\warning La documentation a été récemment mise à jour. Il peut donc rester
des erreurs, des bugs ou des élements non finalisés.

Cette page contient la documentation pour les développeurs de la plate-forme %Arcane.

La page \subpage arcanedoc_news présente la liste des nouveautés de chaque version.
Expand Down
154 changes: 129 additions & 25 deletions arcane/doc/doc_dev/3_env_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,15 @@ comportement à l'exécution:
plus être utilisé (voir Arcane::DIP_Legacy).
</td>
</tr>
<tr>
<td>
ARCANE_TEST_CLEANUP_AFTER_RUN
</td>
<td>
Variable d'environnement permettant de supprimer les fichiers générés par chaque test.
Variable utilisée par `arcane_test_driver`.
</td>
</tr>
<tr>
<td>
ARCANE_LISTENER_TIMEOUT
Expand All @@ -189,30 +198,125 @@ comportement à l'exécution:
todo
</td>
</tr>
<tr>
<td>
ARCANE_PARTICLE_NO_UNIQUE_ID_MAP
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_OLD_EXCHANGE
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_OLD_VARIABLE_SYNC
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_CHANGE_OWNER_ON_INIT
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_NB_EXCHANGE
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_CHECK_EXCHANGE
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_DEBUG_TIED_INTERFACE
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_THREAD_IMPLEMENTATION
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_LISTENER_TIMEOUT
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_VERIF_PARALLEL
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_FORCE_PREPARE_DUMP
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_SERIALIZE_USE_DERIVED_TYPE
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_TRACE_MPI
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_PARALLEL_CHECK_SYNC
</td>
<td>
Usage interne à %Arcane
</td>
</tr>
<tr>
<td>
ARCANE_TRACE_FUNCTION
</td>
<td>
Usage interne à %Arcane
</td>
</tr>

</table>


Les variables d'environnement suivantes peuvent être utilisées mais
sont succeptible de provoquer des instabilitées:

- ...

Les autres variables suivantes sont utilisées mais à usage interne à %Arcane:

- ARCANE_PARTICLE_NO_UNIQUE_ID_MAP
- ARCANE_OLD_EXCHANGE
- ARCANE_OLD_VARIABLE_SYNC
- ARCANE_CHANGE_OWNER_ON_INIT
- ARCANE_NB_EXCHANGE
- ARCANE_CHECK_EXCHANGE
- ARCANE_DEBUG_TIED_INTERFACE
- ARCANE_THREAD_IMPLEMENTATION
- ARCANE_LISTENER_TIMEOUT
- ARCANE_VERIF_PARALLEL
- ARCANE_FORCE_PREPARE_DUMP
- ARCANE_SERIALIZE_USE_DERIVED_TYPE
- ARCANE_TRACE_MPI
- ARCANE_PARALLEL_CHECK_SYNC
- ARCANE_TRACE_FUNCTION

11 changes: 11 additions & 0 deletions arcane/doc/doc_user/chap_execution/3_env_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,17 @@ comportement à l'exécution :
todo
</td>
</tr>
<tr>
<td>
ARCANE_REPLACE_SYMBOLS_IN_DATASET
</td>
<td>
Variable d'environnement permettant d'activer le remplacement des symboles dans
le jeu de données à partir des arguments de la ligne de commande.
Voir la page \ref arcanedoc_execution_commandlineargs
</td>
</tr>


</table>

Expand Down