Skip to content

Commit 9e24daf

Browse files
rokathrokath
committed
wip pages & repo check
1 parent ff1ddce commit 9e24daf

File tree

8 files changed

+78
-87
lines changed

8 files changed

+78
-87
lines changed

β€Ž.github/workflows/README.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Code Scanning Workflows
22

3-
GitHub code scanning is a developer-first, GitHub-native approach to easily find security vulnerabilities before they reach production. Before you can configure code scanning for a repository, you must enable code scanning by adding a GitHub Actions workflow to the repository. For more information, see [Enabling Code Scanning for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository).
3+
GitHub code scanning is a developer-first, GitHub-native approach to easily find security vulnerabilities before they reach production. Before you can configure code scanning for a repository, you must enable code scanning by adding a GitHub Actions workflow to the repository. For more information, see [Enabling Code Scanning for a repository](https://docs.github.com/en/code-security/code-scanning/enabling-code-scanning).
44

β€Ž.github/workflows/link-check.ymlβ€Ž

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,7 @@ jobs:
3535
# in the repository, recursively.
3636
# - You can later add more patterns (e.g. './**/*.html') if needed.
3737
args: >
38-
--verbose
39-
--no-progress
40-
--timeout 15
41-
--max-redirects 5
42-
'./**/*.md'
38+
--config lychee.toml
4339
#
4440
# fail:
4541
# - If true, the workflow will fail when lychee finds broken links.

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ This is a major release hopefully not breaking too much!
158158
* To save space and bandwidth you can use the `*8` and `*16`, macro extensions like with the `TRICE*` macros.
159159
* The default bitwidth is 32-bit but that is changeable in the configuration.
160160
* The `*64` macro extensions are usable for 64-bit values, like `double`.
161-
* See [triceCheck.c](_test/testdata/triceCheck.c) for examples.
161+
* See [triceCheck.c](./_test/testdata/triceCheck.c) for examples.
162162

163163
### 2.3. <a id='common-improvements'></a>Common improvements
164164

@@ -288,7 +288,7 @@ This is a major release hopefully not breaking too much!
288288

289289
* `5af9c2bb664e11e5e2663e56116d842719ca6f8d` Issue \#431 solved
290290
* `430c6a4dde817bc39ec35d595341efbe069cf482` Issue \#466 solved
291-
* You can now use `trice8B( "msg: %02x\n", buffer, len);` functions and the like. See [triceCheck.c](../_test/testdata/triceCheck.c) for examples.
291+
* You can now use `trice8B( "msg: %02x\n", buffer, len);` functions and the like. See [triceCheck.c](./_test/testdata/triceCheck.c) for examples.
292292

293293
## 7. <a id='v0.66.0-changes'></a>v0.66.0 Changes
294294

@@ -692,7 +692,7 @@ Used git log command: `git log --oneline` and less important lines removed
692692
| `fb28cc78` | TriceLogConfiguration function added to examples |
693693
| `faba8336` | Fixed some seldom config variants |
694694
| `2d46233d` | minor Go lint action |
695-
| `4d5f636e` | [triceCheck.c](./_test/testdata/triceCheck.c) now without IDs checked in |
695+
| `4d5f636e` | [triceCheck.c](./_test/testdata/triceCheck.c) now without IDs checked in |
696696
| `50a4dc18` | CYCLE changed to CYCLE_ERROR and reserved for the Trice tool exclusively |
697697
| `1cae53ad` | Update TriceOverRTT.md |
698698
| `dc1cea13` | openocd automation wip |
@@ -1052,7 +1052,7 @@ Used command: `./gitLogWithBranches.sh --since 2025-04-01` and unimportant lines
10521052
* | | 67934b22 2025-06-20 deactivated PATH extension for objcopy
10531053
* | | 8a4d019a 2025-06-19 wip after merging pr \#536
10541054
* | | 7b41a67e 2025-06-16 Fix TestInsertWithBrackets by updating findClosingParentis to handle escaped quotes and parentheses in string literals.
1055-
* | | 8f75007f 2025-06-16 Fix missing closing parenthesis in exampleOfManualJSONencoding() in [triceCheck.c](../_test/testdata/triceCheck.c)
1055+
* | | 8f75007f 2025-06-16 Fix missing closing parenthesis in exampleOfManualJSONencoding() in [triceCheck.c](./_test/testdata/triceCheck.c)
10561056
* | | e88c25f6 2025-06-16 Add Homebrew check and dynamic gcc-arm-embedded version setup in build_environment.sh
10571057
* | | a248cd0d 2025-06-08 Updated G0B1_inst example to demonstrate the use of the Alias feature.
10581058
* | | 2e90daa6 2025-06-08 Omit the Alias field from serialization to minimize the til.json size

β€Ždocs/TriceUserManual.mdβ€Ž

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,7 +1099,7 @@ _Hint:_ I usually have the 32-bit timestamp as millisecond counter and the 16-bi
10991099
| [xtea.h](../src/xtea.h) | XTEA message encryption/decryption interface |
11001100
| [xtea.c](../src/xtea.c) | XTEA message encryption/decryption code |
11011101

1102-
* The *tcobs\*.\** files are copied from [https://github.com/rokath/tcobs/tree/main/v1](https://github.com/rokath/tcobs/tree/main/v1). They are maintained there and extensively tested and probably not a matter of significant change.
1102+
* The *tcobs\*.\** files are copied from [tcobs v1](https://github.com/rokath/tcobs). They are maintained there and extensively tested and probably not a matter of significant change.
11031103
* The SEGGER files are copied and you could check for a newer version at [https://www.segger.com/downloads/jlink/](https://www.segger.com/downloads/jlink/).
11041104

11051105
<p align="right">(<a href="#top">back to top</a>)</p>
@@ -3946,7 +3946,7 @@ TODO: Working example with SEGGER_RTT J-Link and Open OCD
39463946

39473947
### 31.12. <a id='links'></a>Links
39483948

3949-
* [https://www.codeinsideout.com/blog/stm32/j-link-rtt/](https://www.codeinsideout.com/blog/stm32/j-link-rtt/) (A good explanation of SEGGER J-Link Realtime Transfer - Fast Debug protocol: - only suitable for ASCII transfer)
3949+
<!--* [https://www.codeinsideout.com/blog/stm32/j-link-rtt/](https://www.codeinsideout.com/blog/stm32/j-link-rtt/) (A good explanation of SEGGER J-Link Realtime Transfer - Fast Debug protocol: - only suitable for ASCII transfer) -->
39503950
* [USB over WSL2?](https://twitter.com/beriberikix/status/1487127732190212102?s=20&t=NQVa27qvOqPi2uGz6pJNRA) (Maybe intersting for OpenOCD)
39513951
* https://kickstartembedded.com/2024/03/26/openocd-one-software-to-rule-debug-them-all/?amp=1
39523952
* https://mcuoneclipse.com/2021/10/03/visual-studio-code-for-c-c-with-arm-cortex-m-part-9-rtt/
@@ -7403,18 +7403,18 @@ Generated commit message:
74037403

74047404
| Trice Root Folder File | Details |
74057405
|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
7406-
| [.clang-format](../.clang-format) | See [Trice Code Formatting](#trice-code-formatting) |
7407-
| [.clang-format-ignore](../.clang-format-ignore) | See [Trice Code Formatting](#trice-code-formatting) |
7406+
| [.clang-format](../.clang-format) | See [GitHub Action clang-format.yml](#-github-action-clang-format.yml) |
7407+
| [.clang-format-ignore](../.clang-format-ignore) | See [GitHub Action clang-format.yml](#-github-action-clang-format.yml) |
74087408
| [.code_snippets](../.code_snippets) | Some legacy helper code for copying where to use |
7409-
| [.editorconfig](../.editorconfig) | See [Trice Code Formatting](#trice-code-formatting) |
7409+
| [.editorconfig](../.editorconfig) | See [GitHub Action clang-format.yml](#-github-action-clang-format.yml) |
74107410
| [.git](../.git) | version control data base |
7411-
| [.gitattributes](../.gitattributes) | See[Trice Code Formatting](#trice-code-formatting) |
7411+
| [.gitattributes](../.gitattributes) | See[[GitHub Action clang-format.yml](#-github-action-clang-format.yml) |
74127412
| [.github/](../.github/) | [πŸ“ The .github Folder β€” Purpose and Contents](#πŸ“-the-.github-folder-β€”-purpose-and-contents) |
74137413
| [.gitignore](../.gitignore) | git ignores these files |
74147414
| [.goreleaser.yaml](../.goreleaser.yaml) | goreleaser configuration |
74157415
| [.idea/](../.idea/) | GoLand settings |
7416-
| [.lychee.toml](../.lychee.toml) | [Broken Links Check](#broken-links-check) |
7417-
| [.markdownlinkcheck.json](../.markdownlinkcheck.json) | [Broken Links Check](#broken-links-check) |
7416+
| [lychee.toml](../lychee.toml) | [GitHub Action link-check.yml](#github-action-link-check.yml) |
7417+
| [.markdownlinkcheck.json](../.markdownlinkcheck.json) | [GitHub Action link-check.yml](#github-action-link-check.yml) |
74187418
| [.markdownlint.yaml](../.markdownlint.yaml) | [Cleaning the Sources](#cleaning-the-sources) |
74197419
| [.markdownlintignore](../.markdownlintignore) | [Cleaning the Sources](#cleaning-the-sources) |
74207420
| [.travis.yml](../.travis.yml) | Travis CI configuration |
@@ -7429,9 +7429,9 @@ Generated commit message:
74297429
| [_test](../_test) | automatic target code tests |
74307430
| [buildTriceTool.sh](../buildTriceTool.sh) | [Build Trice tool from Go sources](#build-trice-tool-from-go-sources) |
74317431
| [build_environment.sh](../build_environment.sh) | see inside |
7432-
| [clang-format.sh](../clang-format.sh) | [Clang Format](#clang-format) |
7432+
| [clang-format.sh](../clang-format.sh) | See [GitHub Action clang-format.yml](#-github-action-clang-format.yml) |
74337433
| [clean-dsstore.sh](../clean-dsstore.sh) | Ru to remove MacOS artifacts |
7434-
| [coverage.out](../coverage.out) | Go test coverage output |
7434+
| `coverage.out` | Go test coverage output |
74357435
| [cmd/_cui/](../cmd/_cui) | (do not use) command user interface tryout code |
74367436
| [cmd/_stim/](../cmd/_stim) | (do not use) target stimulation tool tryout code |
74377437
| [cmd/clang-filter](../cmd/clang-filter) | [ReadMe](../cmd/clang-filter/ReadMe.md) |
@@ -7447,10 +7447,10 @@ Generated commit message:
74477447
| [gitLogWithBranches.sh](../gitLogWithBranches.sh) | helper to get easy a history view |
74487448
| [go.mod](../go.mod) | Go modules file |
74497449
| [go.sum](../go.sum) | Go modules sums |
7450-
| [index.md](../index.md) | |
7450+
| [index.md](../index.md) | Jekyll index site for RERADME.md |
74517451
| [internal/](../internal) | Trice tool internal Go packages |
74527452
| [pkg/](../pkg) | Trice tool common Go packages |
7453-
| [renewIDs_in_examples_and_test_folder.sh](../renewIDs_in_examples_and_refresh_test_folder.sh) | renew all ID data |
7453+
| [renewIDs_in_examples_and_test_folder.sh](../renewIDs_in_examples_and_refresh_test_folder.sh) | renew all ID data |
74547454
| [src/](../src) | C sources for trice instrumentation -> Add to target project |
74557455
| [super-linter.report/](../super-linter.report/) | super linter output |
74567456
| [temp](../temp) | binary logfiles could appear here |
@@ -7949,7 +7949,7 @@ Broken Links Check
79497949
* Ignore patterns: [.markdownlinkcheck.json](../.markdownlinkcheck.json)
79507950
* Info: `[/] #%F0%9F%93%82-%60.github/workflows%60-%E2%80%94-github-actions-workflows` = skipped check
79517951
* **Local Action:** `lychee .`
7952-
* Uses [.lychee.toml](../.lychee.toml) as configuration
7952+
* Uses [.lychee.toml](../lychee.toml) as configuration
79537953
* **Github Action:** [.github/workflows/link-check.yml](../.github/workflows/link-check.yml)
79547954
<!-- * Exclude files: [.lycheeignore](../.lycheeignore) -->
79557955

@@ -7987,6 +7987,7 @@ Mark stale issues and pull requests
79877987

79887988
#### 44.2.15. <a id='github-action-superlinter.yml'></a>GitHub Action superlinter.yml
79897989

7990+
* **Local Action:** `markdownlint .`
79907991
* Runs GitHub Super Linter, a powerful linting suite. Purpose:
79917992
* ensure consistent code formatting
79927993
* detect stylistic issues
@@ -8005,6 +8006,7 @@ This workflow creates the Trice github pages avaliable under [rokath.github.io/
80058006

80068007
Test Goreleaser
80078008

8009+
* **Local Action:** `goreleaser release --clean --snapshot --skip=publish`
80088010
* **Github Action:** [.github/workflows/test_goreleaser.yml](../.github/workflows/test_goreleaser.yml)
80098011
* Checks if Goreleaser would succeed.
80108012

β€Žformat-dumeng-toc.shβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
# ==============================================================================
5-
# format_dumeng_toc.sh.sh
5+
# format_dumeng_toc.sh
66
#
77
# Purpose
88
# -------
@@ -29,8 +29,8 @@
2929
#
3030
# Usage
3131
# -----
32-
# tools/format_dumeng_toc.sh.sh
33-
# tools/format_dumeng_toc.sh.sh path/to/file.md
32+
# format_dumeng_toc.sh
33+
# format_dumeng_toc.sh path/to/file.md
3434
# ==============================================================================
3535

3636
set -euo pipefail

___index.md renamed to index.md

File renamed without changes.

0 commit comments

Comments
Β (0)