From 87a4a0e395c16d7056cd9a2615c7f58222d03c68 Mon Sep 17 00:00:00 2001 From: schilkp Date: Mon, 15 Jul 2024 13:28:35 +0200 Subject: [PATCH] fix: Various README + Documentation fixes. --- README.md | 6 +++--- docs/intro.md | 6 +++--- docs/tech_details/cobs.md | 2 +- docs/tech_details/trace_format.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d3b7c05..0d59ef5 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Tonbandgerät's [core](https://github.com/schilkp/Tonbandgeraet/tree/main/tband) and handler written in C and designed for embedded systems. It requires minimal porting and configuration, and features multiple backends for gathering and transmitting traces. -It can be used both with an RTOS or in bare-metal environments to instrument user code and track hardware events by tracing interrupts. -Full tracing of FreeRTOS tasks and resources is also supported out-of-the box. +It can be used both with an RTOS, or in bare-metal environments to instrument user code and track hardware events by tracing interrupts. +Full tracing of FreeRTOS tasks and resources is also supported out-of-the-box. Tonbandgerät is based on a simple custom binary trace format designed to be both compact and fairly fast to encode. Recorded traces can be viewed in Google's in-browser perfetto after conversion with the provided CLI tool @@ -31,7 +31,7 @@ The documentation for Tonbandgerät can be found in the `docs/` folder and compi by running `mdbook build` in `docs/`. The latest version of the documentation can also be viewed online [here](https://schilk.co/Tonbandgeraet/docs/index.html). ## Trace Converter + Viewing -The trace converter is written in rust, can be found [here](https://github.com/schilkp/Tonbandgeraet/tree/main/conv). For convenience there is +The trace converter is written in rust, can be found [here](https://github.com/schilkp/Tonbandgeraet/tree/main/conv). For convenience, there is also a WASM version with web frontend, which runs in the browser and can be found [here](https://schilk.co/Tonbandgeraet/). ## Licensing diff --git a/docs/intro.md b/docs/intro.md index d68712c..04d0d68 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -19,8 +19,8 @@ Tonbandgerät's [core](https://github.com/schilkp/Tonbandgeraet/tree/main/tband) and handler written in C and designed for embedded systems. It requires minimal [porting](./porting.md) and [configuration](./config.md), and features multiple [backends](./handling.md) for gathering and transmitting traces. -It can be used both with an RTOS or in bare-metal environments to [instrument user code](./evtmarkers.md) and track hardware events by tracing [interrupts](./interrupts.md). -Full tracing of [FreeRTOS](https://www.freertos.org/index.html) tasks and resources is also supported out-of-the box. +It can be used both with an RTOS, or in bare-metal environments to [instrument user code](./evtmarkers.md) and track hardware events by tracing [interrupts](./interrupts.md). +Full tracing of [FreeRTOS](https://www.freertos.org/index.html) tasks and resources is also supported out-of-the-box. Tonbandgerät is based on a simple custom [binary trace format](./bin_format.md) designed to be fairly fast to encode and keep traces as small as possible. Recorded traces can be viewed in Google's in-browser [perfetto](https://perfetto.dev) after conversion with the provided [CLI](./tband_cli.md) tool @@ -31,7 +31,7 @@ The documentation for Tonbandgerät can be found in the `docs/` folder and compi by running `mdbook build` in `docs/`. The latest version of the documentation can also be viewed online [here](https://schilk.co/Tonbandgeraet/docs/index.html). ## Trace Converter + Viewing -The [trace converter](./doc/tband_cli.md) is written in rust, can be found [here](https://github.com/schilkp/Tonbandgeraet/tree/main/conv). For convenience there is +The [trace converter](./doc/tband_cli.md) is written in rust, can be found [here](https://github.com/schilkp/Tonbandgeraet/tree/main/conv). For convenience, there is also a [WASM version with web frontend](./doc/web.md), which runs in the browser and can be found [here](https://schilk.co/Tonbandgeraet/). ## Licensing diff --git a/docs/tech_details/cobs.md b/docs/tech_details/cobs.md index a1d1311..95a7a46 100644 --- a/docs/tech_details/cobs.md +++ b/docs/tech_details/cobs.md @@ -39,4 +39,4 @@ COBS framed: 0x01 0xFF 0x01 0x02 ... 0xFD 0xFE 0x02 0xFF 0x00 When decoding, the value pointed at by a `0xFF` pointer must therefor not be decoded to a zero but only be interpreted as a another pointer. -Because trace events are usually very short, this means that most can be framed with only two bytes of ove11jrhead. +Because trace events are usually very short, this means that most can be framed with only two bytes of overhead. diff --git a/docs/tech_details/trace_format.md b/docs/tech_details/trace_format.md index c275701..6f055d8 100644 --- a/docs/tech_details/trace_format.md +++ b/docs/tech_details/trace_format.md @@ -1,6 +1,6 @@ # The Tonbandgerät Binary Trace Format -To store trace events in a compact binary format, Tonbandgerät uses zero-delimted [COBS](./cobs.md) +To store trace events in a compact binary format, Tonbandgerät uses zero-delimited [COBS](./cobs.md) frames each containing a single trace event. The [set of trace event types](./bin_events.md) (each identified by an 8 bit id) and their respective structure is fixed.