From f5c6e3881180b3a8ce0ae8eb835f8d9b6e29cb1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20H=C3=B6henleitner?= Date: Wed, 4 Dec 2024 13:22:30 +0100 Subject: [PATCH] wip --- CHANGELOG.md | 15 +++++++-------- docs/README.md | 2 +- docs/TCOBSSpecification.md | 2 -- docs/TraceWithTrice.md | 1 - docs/TriceCacheSpec.md | 1 - docs/TriceConfigProjectImageSizeOptimization.md | 1 - docs/TriceTargetCode.md | 1 - docs/TriceUserManual.md | 6 +++--- 8 files changed, 11 insertions(+), 18 deletions(-) delete mode 100644 docs/TCOBSSpecification.md delete mode 100644 docs/TraceWithTrice.md delete mode 100644 docs/TriceCacheSpec.md delete mode 100644 docs/TriceConfigProjectImageSizeOptimization.md delete mode 100644 docs/TriceTargetCode.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 49df487da..a35d4dc37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -140,7 +140,7 @@ This is a major release hopefully not breaking too much! ### 2.3. Common improvements - Target time stamps now better formatted, Default is `µs`, `ms` is selectable. -- A new document TriceConfigProjectImageSizeOptimization.md was written. +- A new document TriceConfigProjectImageSizeOptimization.md was written. (Now part of TriceUserManual.md) - Trice messages containing several `\n` are better formatted. - Multiple physical channels parallel usable now, like RTT and UART. - A space after ShowID inserted, also after target stamp for better visibility. @@ -177,7 +177,7 @@ This is a major release hopefully not breaking too much! - Code cleanup, tests now ok with `-race`. **Added: `triceAssertTrue` and `triceAssertFalse`**. - CLI switch `-d16` better documented. - **`UserNonBlockingDirectWrite8AuxiliaryFn` and `UserNonBlockingDeferredWrite8AuxiliaryFn` invented for a cleaner auxiliary interface adaption**. -- Doc updated in `TriceUserGuide.md`, `TriceVsPrintfSimilaritiesAndDifferences.md`, `TriceTargetCode.md`, `TriceColor.md` and preface extended. +- Doc updated in `TriceUserGuide.md`, `TriceVsPrintfSimilaritiesAndDifferences.md`, `TriceTargetCode.md` (now in TriceUserManual.md), `TriceColor.md` and preface extended. - Folder `examples` fixed. - Merge pull request [#442](https://github.com/rokath/trice/pull/442) from rokath/dependabot/go_modules/golang.org/x/crypto-0.17.0. - Merge pull request [#437](https://github.com/rokath/trice/pull/437) from hugobpontes/fix_ID_Id_compiler_warnings (add `do ... while (0)` to Id and ID macros. @@ -190,7 +190,7 @@ This is a major release hopefully not breaking too much! - example projects folder re-worked - According issue #456 inside trice.h some renaming to avoid name clashes with other libraries. Only ID, Id, id and iD stayed the same for user code readability and compability. - BuildInfo added to self-compiled Trice compiled binary. -- CGO test dokumentation extended. +- CGO test documentation extended. - CYCLE error now with sound in Trice tool. - Chapter "Trice Limitations" re-worked. - FreeRTOS example added @@ -385,16 +385,15 @@ Used git log command: `git log --pretty=oneline --abbrev-commit` | `944c4982` | clang-format: don't sort include | | `85ae6d65` | clang-format off/on added for TriceCheck | | `72bd7449` | #493 fix (hopefully, untested) | -| `9a7a2eeb` | Update TraceWithTrice.md | | `b6fe0a31` | Update README.md | | `bfb430d0` | Typo correction | | `8bb96662` | edit error corrected | | `95ea617f` | comments updated | -| `00771e2e` | indentiation adapted | +| `00771e2e` | indent adapted | | `f8fcc07c` | c++ frame added | -| `05982811` | indentiation manually adapted and .clang-format-ignore extended | +| `05982811` | indent manually adapted and .clang-format-ignore extended | | `651aac37` | TRICE_BUFFER_SIZE now with 4 additional scratch bytes | -| `afd0da98` | indentiation manually changed for readability | +| `afd0da98` | indent manually changed for readability | | `771754fd` | formatting and comments changed slightly | | `5b4b40d8` | Update README.md | | `b6e68494` | (tag: v0.68.0) rlcp added to .goreleaser.yaml | @@ -505,7 +504,7 @@ Used git log command: `git log --pretty=oneline --abbrev-commit` and less import | `6788972f` | dead code (after removing command update) commented out | | `aa465ca5` | code refactored | | `c5eb2a54` | Update insertIDs.go | -| `8e1a76e9` | Update TriceCacheSpec.md | +| `8e1a76e9` | Update TriceCacheSpec.md (now part of TriceUserManual.md) | | `35fece93` | trice commands `update` and `zero` removed. | | `7e2494bb` | Bugfix in helpinfo.go: update params where shown in insert params. | | `75010487` | Hint "EXPERIMENTAL!" to `-cache` switch | diff --git a/docs/README.md b/docs/README.md index ea5df5168..342bf886d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1 @@ -All files here only links into [TriceUserManual.md](./TriceUserManual.md). \ No newline at end of file +Look at the [TriceUserManual.md](./TriceUserManual.md) - other files here only links ⚓. \ No newline at end of file diff --git a/docs/TCOBSSpecification.md b/docs/TCOBSSpecification.md deleted file mode 100644 index 5fbff62b7..000000000 --- a/docs/TCOBSSpecification.md +++ /dev/null @@ -1,2 +0,0 @@ - -Moved to separate repository [https://github.com/rokath/TCOBS](https://github.com/rokath/TCOBS) diff --git a/docs/TraceWithTrice.md b/docs/TraceWithTrice.md deleted file mode 100644 index d9c203fd8..000000000 --- a/docs/TraceWithTrice.md +++ /dev/null @@ -1 +0,0 @@ -# [TriceUserManual.md](./TriceUserManual.md) \ No newline at end of file diff --git a/docs/TriceCacheSpec.md b/docs/TriceCacheSpec.md deleted file mode 100644 index 4a1cc5115..000000000 --- a/docs/TriceCacheSpec.md +++ /dev/null @@ -1 +0,0 @@ -# [TriceUserManual.md/#trice-cache](./TriceUserManual.md/#trice-chache) \ No newline at end of file diff --git a/docs/TriceConfigProjectImageSizeOptimization.md b/docs/TriceConfigProjectImageSizeOptimization.md deleted file mode 100644 index caa6da9e8..000000000 --- a/docs/TriceConfigProjectImageSizeOptimization.md +++ /dev/null @@ -1 +0,0 @@ -# [TriceUserManual.md/#trice-project-image-size-optimization](./TriceUserManual.md/#trice-project-image-size-optimization) \ No newline at end of file diff --git a/docs/TriceTargetCode.md b/docs/TriceTargetCode.md deleted file mode 100644 index 6ee80a10e..000000000 --- a/docs/TriceTargetCode.md +++ /dev/null @@ -1 +0,0 @@ -# [TriceUserManual.md/#trice-target-code-implementation](./TriceUserManual.md/#trice-target-code-implementation) \ No newline at end of file diff --git a/docs/TriceUserManual.md b/docs/TriceUserManual.md index 0e3de2413..f85c80c3c 100644 --- a/docs/TriceUserManual.md +++ b/docs/TriceUserManual.md @@ -3,7 +3,7 @@ # Trice User Manual ```diff ---> To Long To Read❗ +--> To Long To Read - use it as reference only❗ + Speed of Light `printf` Comfort Within Interrupts And Everywhere + ``` @@ -46,8 +46,8 @@ https://apps.timwhitlock.info/emoji/tables/unicode --> --- - -
Table of Contents
    +

    Table of Contents

    +
    (click to expand)