Adds support for --help option #170
Conversation
NanoNabla
force-pushed
the
pr_165
branch
2 times, most recently
from
74ba099 to
07a34a2
Compare
| --instrumenter-type=<t> Specify custom instrumenter type (e.g., cProfile). | ||
| --instrumenter-file=<f> Path to a Python script that is executed before the application. | ||
| Allows instrumentation of specific modules and functions without modifying their source code. | ||
| -- Stop parsing Score-P options; pass following args to your script. |
There was a problem hiding this comment.
| -- Stop parsing Score-P options; pass following args to your script. | |
| -- Stop parsing Score-P options; pass following args to your script. |
that could be understood that --foo -- --baz ./bar --arg will be ./bar --arg --baz
"; interpret all following arguments verbatim as the program with its arguments"
| --nocompiler Disable compiler-based instrumentation. | ||
| --nopython Disable instrumentation of Python code. | ||
| Instrumentation can still be enabled later from within the application's source code. | ||
| --noinstrumenter Same as --nopython. |
There was a problem hiding this comment.
time to deprecate that option?
There was a problem hiding this comment.
add --instrumenter-type=none in the future? and make --noinstrumenter an alias?
| --help Show this help message and exit. | ||
| --mpi Enable MPI instrumentation (equivalent to --mpp=mpi). | ||
| --keep-files Keep temporary files after execution. | ||
| --verbose, -v Enable verbose output for debugging and tracing. |
There was a problem hiding this comment.
what means "tracing" in this context?
| Score-P Python instrumentation wrapper. The following options control how the program is instrumented and executed: | ||
|
|
||
| --help Show this help message and exit. | ||
| --mpi Enable MPI instrumentation (equivalent to --mpp=mpi). |
There was a problem hiding this comment.
is this already marked as deprecated?
There was a problem hiding this comment.
--mpi is a wrapper for --mpp=mpi in the bindings, designed to make it more intuitive for Python users. I get the point why to mark it deprecated
There was a problem hiding this comment.
the code does not support your claim. if so, --mpp=mpi should be handled by Python too, but its not, and --mpi just passes --mpp=mpi to scorep-config. The README uses --mpp=mpi and notes that "The traditional --mpi does still work". so advertising it in the --help does not make sense to me. --mpp=mpi should, and thats why I suggested to add a "Common options to Score-P"-section, which should also mention --thread=pthread or --thread=ompt, if thats supported by Score-P
There was a problem hiding this comment.
--mpp-mpi is passed directly to scorep-config and works without any special handling of Python. Therefore I didn't mention it here.
If you really want to, we can deprecate --mpi and remove it in the near future. From my point of view, it's currently being used mainly for convenience.
Alternatively, we could just update the README.
I’ve deliberately avoided listing scorep-config options so far and instead referred to scorep-config --help, because I don’t want to maintain that across different Score-P versions.
For example --io=runtime:posix works in older Score-P versions regardless of the bindings.
| Allows instrumentation of specific modules and functions without modifying their source code. | ||
| -- Stop parsing Score-P options; pass following args to your script. | ||
|
|
||
| Other options starting with '-' are passed directly to 'scorep-config'. |
There was a problem hiding this comment.
that needs to be more prominent at the beginning
| --mpi Enable MPI instrumentation (equivalent to --mpp=mpi). | ||
| --keep-files Keep temporary files after execution. | ||
| --verbose, -v Enable verbose output for debugging and tracing. |
There was a problem hiding this comment.
maybe put these into its own section name "Common options from scorep-config"
There was a problem hiding this comment.
All 3 parameters are specific to the bindings and do not originate directly from scorep-config.
There was a problem hiding this comment.
--mpi:
elif elem == "--mpi":
scorep_config.append("--mpp=mpi")
There was a problem hiding this comment.
It is passing something to scorep_config but it is not an option which originate directly from scorep-config
$ scorep-config --help | grep -- '--mpi'
--mpicc Prints the MPI C compiler name.
--mpicxx Prints the MPI C++ compiler name.
--mpifc Prints the MPI Fortran compiler name.
--mpilibtool
That are common options for scorep-config as well as --mpp=mpi but not --mpi
There was a problem hiding this comment.
--mpi does not show up in --help as it is marked deprecated
Co-authored-by: Bert Wesarg <[email protected]>
Co-authored-by: Bert Wesarg <[email protected]>
Fixes #165