Fix docs using -D instead of -G (#73)

- omnitrace-avail option is -G, not -D
This commit is contained in:
Jonathan R. Madsen
2022-06-28 21:53:53 -05:00
کامیت شده توسط GitHub
والد fadcfa36da
کامیت da07d88f99
2فایلهای تغییر یافته به همراه4 افزوده شده و 4 حذف شده
+1 -1
مشاهده پرونده
@@ -15,7 +15,7 @@ The full documentation for [omnitrace](https://github.com/AMDResearch/omnitrace)
### Omnitrace Settings
Generate an omnitrace configuration file using `omnitrace-avail -D omnitrace.cfg`. Optionally, use `omnitrace-avail -D omnitrace.cfg --all` for
Generate an omnitrace configuration file using `omnitrace-avail -G omnitrace.cfg`. Optionally, use `omnitrace-avail -G omnitrace.cfg --all` for
a verbose configuration file with descriptions, categories, etc. Modify the configuration file as desired, e.g. enable
[perfetto](https://perfetto.dev/), [timemory](https://github.com/NERSC/timemory), sampling, and process-level sampling by default
and tweak some sampling default values:
+3 -3
مشاهده پرونده
@@ -15,7 +15,7 @@ propagated to `omnitrace-avail`, thus it should be viewed as the single source o
information or missing feature is found in this documentation.
It is recommended to create a default configuration file in `${HOME}/.omnitrace.cfg`. This can be done via
executing `omnitrace-avail -D ~/.omnitrace.cfg`, or optionally, use `omnitrace-avail -D ~/.omnitrace.cfg --all`
executing `omnitrace-avail -G ~/.omnitrace.cfg`, or optionally, use `omnitrace-avail -G ~/.omnitrace.cfg --all`
for a verbose configuration file with descriptions, categories, etc.
Modify `${HOME}/.omnitrace.cfg` as desired, e.g. enable [perfetto](https://perfetto.dev/),
@@ -85,7 +85,7 @@ omnitrace-avail --hw-counters --description
#### Generating Default Configuration
```console
$ omnitrace-avail -D ~/.omnitrace.cfg
$ omnitrace-avail -G ~/.omnitrace.cfg
[omnitrace-avail] Outputting text configuration file '/home/user/.omnitrace.cfg'...
$ cat ~/.omnitrace.cfg
# auto-generated by omnitrace-avail (version 1.2.0) on 2022-06-27 @ 19:15
@@ -762,7 +762,7 @@ $ omnitrace-avail -H -bd
## Creating a Configuration File
[Omnitrace](https://github.com/AMDResearch/omnitrace) supports 3 configuration file formats: JSON, XML, and plain text.
Use `omnitrace-avail -D <filename> -F txt json xml` to generate default configuration files of each format and, optionally,
Use `omnitrace-avail -G <filename> -F txt json xml` to generate default configuration files of each format and, optionally,
include the `--all` flag for descriptions, etc.
Configuration files are specified via the `OMNITRACE_CONFIG_FILE` environment variable
and by default will look for `${HOME}/.omnitrace.cfg` and `${HOME}/.omnitrace.json`.