Skip to content

Commit

Permalink
#2826: Add config documentation to user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mo-alistairp committed Jan 9, 2025
1 parent 6df1873 commit bbeb181
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/psyad/user_guide/psyad_command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ by the command:
.. parsed-literal::
>>> psyad -h
usage: psyad [-h] [-oad OAD] [-v] [-t] [-api API] [-coord-arg COORD_ARG] [-panel-id-arg PANEL_ID_ARG] [-otest TEST_FILENAME] -a ACTIVE [ACTIVE ...] -- filename
usage: psyad [-h] [-oad OAD] [-c CONFIG] [-v] [-t] [-api API] [-coord-arg COORD_ARG] [-panel-id-arg PANEL_ID_ARG] [-otest TEST_FILENAME] -a ACTIVE [ACTIVE ...] -- filename
Run the PSyclone adjoint code generator on a tangent-linear kernel file
Expand All @@ -73,6 +73,8 @@ by the command:
-h, --help show this help message and exit
-a ACTIVE [ACTIVE ...], --active ACTIVE [ACTIVE ...]
name of active variables
-c CONFIG, --config CONFIG
config file with PSyclone specific options
-v, --verbose increase the verbosity of the output
-t, --gen-test generate a standalone unit test for the adjoint code
-api API the PSyclone API that the TL kernel conforms to (if any)
Expand Down

0 comments on commit bbeb181

Please sign in to comment.