Omnitrace sample documentation (#179)

* Documentation for omnitrace-sample

* Improve omnitrace-sample

- improve the printing of the env updates
- remove env settings when something is deactivated
- restore env settings when something is deactivated
このコミットが含まれているのは:
Jonathan R. Madsen
2022-10-19 03:30:00 -05:00
committed by GitHub
コミット 67f7471253
15個のファイルの変更789行の追加92行の削除
+6 -2
ファイルの表示
@@ -1,4 +1,4 @@
# Instrumenting with Omnitrace
# Binary Instrumentation
```eval_rst
.. toctree::
@@ -8,9 +8,13 @@
## omnitrace Executable
> ***NOTE: With the introduction of `omnitrace-sample`, in future versions of omnitrace, the current `omnitrace` executable***
> ***noted below will likely be renamed to `omnitrace-instrument` and a new `omnitrace` executable will serve as a common***
> ***executable for multiple executables, e.g. `omnitrace sample ...`, `omnitrace run ...`, `omnitrace rewrite ...`, etc.***
Instrumentation is performed with the `omnitrace` executable. View the help menu with the `-h` / `--help` option:
```shell
```console
$ omnitrace --help
[omnitrace] Usage: omnitrace [ --help (count: 0, dtype: bool)
--debug (max: 1, dtype: bool)