Skip to content

Commit 0017f2a

Browse files
committed
docs: link manuals to generated CLI help
1 parent db4c87b commit 0017f2a

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/TriceUserManual.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ Making it facile for a user to use Trice was the driving point just to have
533533

534534
Trice understands itself as a silent helper in the background to give the developer more focus on its real task. If, for example, `trice log` is running and you re-flash the target, there is ***no need to restart*** the Trice tool. When [til.json](https://github.com/rokath/trice/blob/main/demoTIL.json) was updated in a pre-build step, the Trice tool automatically reloads the new data during logging.
535535

536-
The Trice tool comes with many command line switches (`trice help -all`) for tailoring various needs, but mostly these are not needed. <small>In file [../internal/args/tricehelpall_test.go](https://github.com/rokath/trice/blob/main/internal/args/tricehelpall_test.go) the expected test output contains this information as well.</small>
536+
The Trice tool comes with many command line switches (`trice help -all`) for tailoring various needs, but mostly these are not needed. <small>The generated file [../docs/ref/trice-help-all.txt](https://github.com/rokath/trice/blob/main/docs/ref/trice-help-all.txt) contains this information as well.</small>
537537

538538
Normal Trice tool usage is:
539539
* [./build.sh](https://github.com/rokath/trice/blob/main/examples/L432_inst/build.sh) containing `trice insert -cache`, `make` and `trice clean -cache`
@@ -689,7 +689,7 @@ The Trice tool is expandable with several decoders. So it is possible to impleme
689689

690690
When less RAM usage is more important the target double buffer is replaceable with a ring buffer. So the user will be able to decide at compile time about that. A ring buffer mode is selectable inside [triceConfig.h](https://github.com/rokath/trice/blob/main/examples/F030_inst/Core/Inc/triceConfig.h) avoiding any buffer by paying a time toll.
691691

692-
The Trice tool supports [many command line switches](https://github.com/rokath/trice/blob/main/internal/args/tricehelpall_test.go).
692+
The Trice tool supports [many command line switches](https://github.com/rokath/trice/blob/main/docs/ref/trice-help-all.txt).
693693

694694
### 4.16. <a id='optional-trice-messages-encryption'></a>Optional Trice messages encryption
695695

@@ -1966,7 +1966,7 @@ It is up to the user to provide the functions `TriceStamp16` and/or `TriceStamp3
19661966

19671967
### 18.1. <a id='target-(time)stamps-formatting'></a>Target (Time)Stamps Formatting
19681968

1969-
To get a short overview run [trice help -log](https://github.com/rokath/trice/blob/main/internal/args/tricehelpall_test.go) and read about the CLI switches `ts`, `ts0`, `ts16`, `ts32`. The `ts32` switch supports also "epoch" now as format. That is useful for example, if the binary logs are stored internally in the device flash and read out later. Such usage assumes 1 second as ts32 unit in `uint32_t` format and the Trice tool displays the UTC time. It is also possible to adapt the displayed format like this for example: `trice log -ts32='epoch"06-01-02_15:04:05"'`. The additional passed string must match the Go time package capabilities. A few examples:
1969+
To get a short overview run `trice help -log` and read about the CLI switches `ts`, `ts0`, `ts16`, `ts32` in the generated [CLI help file](https://github.com/rokath/trice/blob/main/docs/ref/trice-help-all.txt). The `ts32` switch supports also "epoch" now as format. That is useful for example, if the binary logs are stored internally in the device flash and read out later. Such usage assumes 1 second as ts32 unit in `uint32_t` format and the Trice tool displays the UTC time. It is also possible to adapt the displayed format like this for example: `trice log -ts32='epoch"06-01-02_15:04:05"'`. The additional passed string must match the Go time package capabilities. A few examples:
19701970

19711971
```bash
19721972
trice log -port FILEBUFFER -args myLogs.bin -ts32='"Mon Jan _2 15:04:05 2006"' # ANSIC

docs/TriceUserManual_AI_reworked_NOT_reviewed.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ Making it facile for a user to use Trice was the driving point just to have
577577

578578
Trice understands itself as a silent helper in the background to give the developer more focus on its real task. If, for example, `trice log` is running and you re-flash the target, there is ***no need to restart*** the Trice tool. When [til.json](https://github.com/rokath/trice/blob/main/demoTIL.json) was updated in an pre-build step, the Trice tool automatically reloads the new data during logging.
579579

580-
The Trice tool comes with many command line switches (`trice help -all`) for tailoring various needs, but mostly these are not needed. <small>In file [../internal/args/tricehelpall_test.go](https://github.com/rokath/trice/blob/main/internal/args/tricehelpall_test.go) the expected test output contains this information as well.</small>
580+
The Trice tool comes with many command line switches (`trice help -all`) for tailoring various needs, but mostly these are not needed. <small>The generated file [../docs/ref/trice-help-all.txt](https://github.com/rokath/trice/blob/main/docs/ref/trice-help-all.txt) contains this information as well.</small>
581581

582582
Normal Trice tool usage is:
583583
* [./build.sh](https://github.com/rokath/trice/blob/main/examples/L432_inst/build.sh) containing `trice insert -cache`, `make` and `trice clean -cache`
@@ -733,7 +733,7 @@ The Trice tool is expandable with several decoders. So it is possible to impleme
733733

734734
When less RAM usage is more important the target double buffer is replaceable with a ring buffer. So the user will be able to decide at compile time about that. A ring buffer mode is selectable inside [triceConfig.h](https://github.com/rokath/trice/blob/main/examples/F030_inst/Core/Inc/triceConfig.h) avoiding any buffer by paying a time toll.
735735

736-
The Trice tool supports [many command line switches](https://github.com/rokath/trice/blob/main/internal/args/tricehelpall_test.go).
736+
The Trice tool supports [many command line switches](https://github.com/rokath/trice/blob/main/docs/ref/trice-help-all.txt).
737737

738738
### 4.16. <a id='optional-trice-messages-encryption'></a>Optional Trice messages encryption
739739

@@ -6580,7 +6580,7 @@ It is up to the user to provide the functions `TriceStamp16` and/or `TriceStamp3
65806580

65816581
### 37.1. <a id='target-(time)stamps-formatting'></a>Target (Time)Stamps Formatting
65826582

6583-
To get a short overview run [trice help -log](https://github.com/rokath/trice/blob/main/internal/args/tricehelpall_test.go) and read about the CLI switches `ts`, `ts0`, `ts16`, `ts32`. The `ts32` switch supports also "epoch" now as format. That is useful for example, if the binary logs are stored internally in the device flash and read out later. Such usage assumes 1 second as ts32 unit in `uint32_t` format and the Trice tool displays the UTC time. It is also possible to adapt the displayed format like this for example: `trice log -ts32='epoch"06-01-02_15:04:05"'`. The additional passed string must match the Go time package capabilities. A few examples:
6583+
To get a short overview run `trice help -log` and read about the CLI switches `ts`, `ts0`, `ts16`, `ts32` in the generated [CLI help file](https://github.com/rokath/trice/blob/main/docs/ref/trice-help-all.txt). The `ts32` switch supports also "epoch" now as format. That is useful for example, if the binary logs are stored internally in the device flash and read out later. Such usage assumes 1 second as ts32 unit in `uint32_t` format and the Trice tool displays the UTC time. It is also possible to adapt the displayed format like this for example: `trice log -ts32='epoch"06-01-02_15:04:05"'`. The additional passed string must match the Go time package capabilities. A few examples:
65846584

65856585
```bash
65866586
trice log -port FILEBUFFER -args myLogs.bin -ts32='"Mon Jan _2 15:04:05 2006"' # ANSIC

0 commit comments

Comments
 (0)