Skip to content

Commit

Permalink
fix: Various README + Documentation fixes.
Browse files Browse the repository at this point in the history
schilkp committed Jul 15, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent ed8162b commit 87a4a0e
Showing 4 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/tech_details/cobs.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/tech_details/trace_format.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 87a4a0e

Please sign in to comment.