polish 0 according superlinter job

Author: rokath

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +25,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

CODE_OF_CONDUCT.md

@@ -68,9 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
 
-[homepage]: https://www.contributor-covenant.org
+[homepage](https://www.contributor-covenant.org)
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright © 2020 Thomas.Hoehenleitner [at] seerose.net
 

README.md

@@ -46,8 +46,15 @@ Tiny & fast trace code for embedded device real-time PC logging (trace ID visual
 
 - Printf-like trace macros `TRICE` and PC `trice` tool (written in [Go](https://en.wikipedia.org/wiki/Go_(programming_language))) for automatic ID managing & logging.
 - Communication without string transfer, just with IDs. Prerequisite: byte transmission to PC, low bandwidth is ok:
-  - method does'nt matter: [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter), [I²C](https://en.wikipedia.org/wiki/I%C2%B2C), [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface), [GPIO](https://circuitcellar.com/cc-blog/a-trace-tool-for-embedded-systems/), [RTT](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/), [CAN](https://en.wikipedia.org/wiki/CAN_bus), [LIN](https://en.wikipedia.org/wiki/Local_Interconnect_Network), ...
-- "log in (a) trice" ([S>G](https://www.screentogif.com/)) ![ ](./docs/README.media/life0.gif) 
+  - method does'nt matter: \
+  [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter), \
+  [I²C](https://en.wikipedia.org/wiki/I%C2%B2C), \
+  [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface), \
+  [GPIO](https://circuitcellar.com/cc-blog/a-trace-tool-for-embedded-systems/), \
+  [RTT](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/), \
+  [CAN](https://en.wikipedia.org/wiki/CAN_bus), \
+  [LIN](https://en.wikipedia.org/wiki/Local_Interconnect_Network), ...
+- "log in (a) trice" ([S>G](https://www.screentogif.com/)) ![ ](./docs/README.media/life0.gif)
 - Main idea: Logging strings **not** into an embedded device to display them later on a PC but keep usage comfortable and simple.
 
 ## `TRICE` macros for C & C++ code
@@ -58,7 +65,7 @@ Tiny & fast trace code for embedded device real-time PC logging (trace ID visual
 ## Possible Use Cases
 
 - Using trice not only for **dynamic debugging** but also as **logging** technique
-    is possible and gives the advantage to have very short messages (no strings) for transmission, 
+    is possible and gives the advantage to have very short messages (no strings) for transmission,
     but keep in mind that the file [til.json](https://github.com/rokath/trice/blob/master/til.json) is the key to read all output if your devices in the field for 10 or more years.
 - You can consider TRICE also as a kind of **data compression** what could be interesting for IoT things, especially NB-IoT, where you have very low data rates.
 - Storing trices in FLASH for later log analysis saves memory because a `TRICE` occupies only 4 bytes.
@@ -77,7 +84,7 @@ Tiny & fast trace code for embedded device real-time PC logging (trace ID visual
 
 - Mixed case trice macros are short trices and the letter i at the end says **i**nside critical section. (FLEX encoding)
 - `Trice16_1s( "tim: myFunc %d\n", sysTick );` before and after a function call lets you easy measure the function execution time.
-- As graphical vizualisation you could use a tool similar to https://github.com/sqshq/sampler.
+- As graphical vizualisation you could use a tool similar to [https://github.com/sqshq/sampler](https://github.com/sqshq/sampler).
 - TRICE has intentionally no target timestamps for performance reasons. On the PC you can display the *reception timestampts*. But you can add own **timestamps as parameters** for exact embedded time measurements. Having several devices with trice timestamps, **network timing measurement** is possible.
 
 ## How it approximately works

docs/CommandLineExamples.md

@@ -15,9 +15,9 @@
 ## OPTIONS
 
 - The **trice** command accepts one and only one sub-command (which can be inside the config file) followed by optional flags: `trice [s|subcommand [-f|flag [value]] [...]]`
-- The flags start with a single dash and are boolean or need a value separated by space or `=`. 
+- The flags start with a single dash and are boolean or need a value separated by space or `=`.
 - Flags in square brackets `[]` are optional. If omitted they have a default value depending on the context.
-- Some flags can occur several times. Check with `trice h` for multi-flags. 
+- Some flags can occur several times. Check with `trice h` for multi-flags.
 - Command line subcommand and flags are overwriting config file values.
 - A subcommand in the command line is the selected subcommand in config files if there is any.
 - You can place different subcommands with flags in a config file and specify only a subcommand in the command line for selection, like `trice u` and `trice l`.
@@ -88,16 +88,16 @@ Log trice messages from -source and display them line by line. Default destinati
 - `-postfix string` Add string as postfix to end of each trice log line. It defaults to *\n*. The value *\n* was internally removed before, so the default value results to the original string.
 - `-s|source COMn|filename|JLRTT|STRTT|RND|SIM [-p|param string]]` Use source as trice input. The switch -param is accordingly to source.
   - **COMn**: COM15 as example. The only possible parameter is the baud rate. *-param 115200* is default value.
-  - **filename**: 
+  - **filename**:
     - **NOT IMPLEMENTED** When filename is an executable it is started with a random temporary logfile, internally read from. -param is accordingly to the executable command line.
     - When filename is a binary file this file is read and data interpreted according to -format switch.
     - **NOT IMPLEMENTED** When filename is an ASCII file, lines are diplayed. Can be used with logfiles. Default logging is off in that case.
   - **JLRTT** Starts the *JLinkRTTLogger* executable which is expected in the trice executable directory together with acompanying libraries. The -param string is according to *JLinkRTTLogger* description.
   - **STRTT** **NOT IMPLEMENTED** Starts the *STLinkRTTLogger* executable which is expected in the trice executable directory together with acompanying libraries. The -param string is according to *STLinkRTTLogger* description.
   - **RND**: random data are used as input and interpreted according to -format switch. The switch -param is used as control for the random generator. Default is total random data. Usable for testing.
-    - *-param=wrap* generates valid wrap data with random payload. 
+    - *-param=wrap* generates valid wrap data with random payload.
   - **SIM**: inputDummy data are used as input and interpreted according to -format switch. The switch -param is used as control for the inputDummy generator. Usable for testing.
-    - *-param=name* uses simulation dataset *name*. 
+    - *-param=name* uses simulation dataset *name*.
 - `-color off|alternate` Switch color off or use alternate color set. Ignored when switch -remote is used.
 - `-r|remote no|ds|displayserver|IPaddr:IPport` Do not show loglines and send them to a displayserver instead. Default is no. localhost:61497.
 - `-a|autostart cmd` Start `cmd` in background. Try `trice ds` to start displayserver automatically.
@@ -149,13 +149,13 @@ trice
 trice -sd -r 192.168.1.23:45678
 ```
 
-- Play recorded wrap format binary file *log.bin* 
+- Play recorded wrap format binary file *log.bin*
 
 ```b
 trice l -s log.bin -f w
 ```
 
-- Start *JLinkRTTLogger* manually on Windows and use RTT channel 0. 
+- Start *JLinkRTTLogger* manually on Windows and use RTT channel 0.
 
 ```b
 trice log -s="C:\\Program Files (x86)\\SEGGER\\JLink\\JLinkRTTLogger.exe" -p="-Device STM32F030R8 -if SWD -RTTChannel 0" 

docs/Common.md

@@ -28,18 +28,33 @@ Automatically the ID is added to an [ID list](https://github.com/rokath/trice/bl
 When the embedded project is compiled, only the ID goes to the binary
 but not the format string, what results in a smaller memory footprint.
 
-On execution the ID is pushed into a FIFO together with the optional trice parameters and that is the real fast and important part which could be finished within 12-14 processor clocks (measured on a ARM M0 with `Trice16_1i`). At 48 MHz the in time needed light travels less than 100 meters. Slightly delayed in the background the TRICE trace goes to the communication port, what is also fast compared to all the actions behind a `printf()` statement.
+On execution the ID is pushed into a FIFO together with the optional trice parameters and that is the real fast \
+and important part which could be finished within 12-14 processor clocks (measured on a ARM M0 with `Trice16_1i`). \
+At 48 MHz the in time needed light travels less than 100 meters. \
+Slightly delayed in the background the TRICE trace goes to the communication port, what is also fast compared to all the actions behind a `printf()` statement.
 
 Please understand, that when debugging code containing TRICE\* statements, during a TRICE\* step-over only  one ore more 32 bit values go into the internal fifo buffer and no serial output
 is visible because of the stopped target. But the SEGGER debug probe reads out the RTT memory and this way also during debug stepping realtime trice output is visible. That is (right now) not true for the STLINK interface because the is only one USB enpoint.
 
 ## trice instructions: `TRICE`, `Trice` or `trice` with or without ending letter 'i'?
 
-There are several types of trice statements. All trice statements can have an additional letter 'i'. This means **i**nside critical section. You can use these when it is sure not to get interrupted by other trices. If for example an interrupt contains a trice statement this can be an i-trice but other trices not allowed to be an i-trice, they need to be normal trices, which are protected against interruption. If you are not sure it is always safe to use normal trices (without ending 'i'). The i-trices are a bit faster what is not relevant in most cases because of the general speed.
-
-- `Trice0`, `Trice8_1`, `Trice16_1` and `Trice8_2` are so called short trice macros. They use internal a smaller encoding and have only a 15-bit ID size, means ID's 1-32767 are usable. These are the fastest trices and with them the speed limit is reached. ![x](README.media/Trice16_1-Code.PNG)![x](README.media/Trice16_1i-Code.PNG)![x](README.media/Trice16_1i.PNG) The number in the blue lines is the current processor tick. For `Trice16_1i` the difference between neibours is about 13 clocks. Short trices need 'id(0)' instead 'Id(0)' as important difference to normal trices.
-- `TRICE0`, `TRICE8_1`, ... `TRICE8_8`, `TRICE16_1`, ... `TRICE16_4`, `TRICE32_1`, ... `TRICE32_4`, `TRICE64_1`, `TRICE64_2` are normal trice macros. They insert code directly (no function call) for better performance but the drawback is the rising code amount when many trices are used.
-- `trice0`, `trice8_1`, ... `trice8_8`, `trice16_1`, ... `trice16_4`, `trice32_1`, ... `trice32_4`, `trice64_1`, `trice64_2` are normal trice functions. The function call overhead is reasonable and the advantage is significant less code amount when many trices are used.
+There are several types of trice statements. All trice statements can have an additional letter 'i'. This means **i**nside critical section. \
+You can use these when it is sure not to get interrupted by other trices. If for example an interrupt contains a trice statement this can be \
+an i-trice but other trices not allowed to be an i-trice, they need to be normal trices, which are protected against interruption. \
+If you are not sure it is always safe to use normal trices (without ending 'i'). The i-trices are a bit faster what is not relevant in most cases because of the general speed.
+
+- `Trice0`, `Trice8_1`, `Trice16_1` and `Trice8_2` are so called short trice macros.\
+They use internal a smaller encoding and have only a 15-bit ID size, means ID's 1-32767 are usable.\
+These are the fastest trices and with them the speed limit is reached.\
+![x](README.media/Trice16_1-Code.PNG)\
+![x](README.media/Trice16_1i-Code.PNG)\
+![x](README.media/Trice16_1i.PNG)\
+The number in the blue lines is the current processor tick. For `Trice16_1i` the difference between neibours is about 13 clocks. \
+Short trices need 'id(0)' instead 'Id(0)' as important difference to normal trices.
+- `TRICE0`, `TRICE8_1`, ... `TRICE8_8`, `TRICE16_1`, ... `TRICE16_4`, `TRICE32_1`, ... `TRICE32_4`, `TRICE64_1`, `TRICE64_2` are normal trice macros. \
+They insert code directly (no function call) for better performance but the drawback is the rising code amount when many trices are used.
+- `trice0`, `trice8_1`, ... `trice8_8`, `trice16_1`, ... `trice16_4`, `trice32_1`, ... `trice32_4`, `trice64_1`, `trice64_2` are normal trice functions. \
+The function call overhead is reasonable and the advantage is significant less code amount when many trices are used.
 - For most flexibility the code for each trice function can be enabled or not inside the triceConfig.h.
 
 ## `trice` tool
@@ -523,4 +538,7 @@ example: 'trice zeroSourceTreeIds -src ../A': Sets all TRICE IDs to 0 in ../A. U
 ### Color issues under Windows
 
 **Currently CMD console colors are not enabled by default in Win10**, so if you see no color but escape sequences on your powershell or cmd window, please refer to
-[Windows console with ANSI colors handling](https://superuser.com/questions/413073/windows-console-with-ansi-colors-handling/1050078#1050078) or simply use a Linux like terminal under windows, like git-bash. One option is also to install Microsoft *Windows Terminal (Preview)* from inside the Microsoft store and to start trice inside there. Unfortunally this can not be done automatically right now because of missing commandline switches.
+[Windows console with ANSI colors handling](https://superuser.com/questions/413073/windows-console-with-ansi-colors-handling/1050078#1050078)\
+or simply use a Linux like terminal under windows, like git-bash.\
+One option is also to install Microsoft *Windows Terminal (Preview)* from inside the Microsoft store\
+and to start trice inside there. Unfortunally this can not be done automatically right now because of missing commandline switches.

docs/Manuals/ConfigFile.md

@@ -6,7 +6,7 @@
 
 ## Rules
 
-- The `trice` command  can be called without parameters. 
+- The `trice` command  can be called without parameters.
   - In that case it needs to find at least one config file named *trice.conf.json*.
 - The `trice` command can be called with a single sub-command plus an optional dashed parameter list.
   - In that case it looks also for a config file named *trice.conf.json* for additional settings.

docs/Manuals/Rutronik.md

@@ -15,7 +15,7 @@ J-Link ist ja wahrscheinlich schon vorhanden und ist einen ersten Versuch wert,
 
 (Alternativ dazu kann man sich ein eigenes Tool für den virtuellen COM-Port stricken)
 
-ST ist ebenfalls auf github aktiv: https://github.com/STMicroelectronics
+ST ist ebenfalls auf github aktiv: [https://github.com/STMicroelectronics](https://github.com/STMicroelectronics)
 
 Es gibt [STM32Cube expansion packages](https://www.st.com/en/embedded-software/stm32cube-expansion-packages.html#products)
 

docs/OneWireOption.md

@@ -11,4 +11,11 @@ Because the trice tool needs only to receive, a single UART-TX pin will do. But
 
 - The 2 images are taken from [https://circuitcellar.com/cc-blog/a-trace-tool-for-embedded-systems/](https://circuitcellar.com/cc-blog/a-trace-tool-for-embedded-systems/). See there for more information.
 - As trace dongle you can use any spare microcontroller board with an UART together with an FTDI USB converter.
-  - This allowes also any other data path - method does'nt matter: [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter), [I²C](https://en.wikipedia.org/wiki/I%C2%B2C), [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface), [GPIO](https://circuitcellar.com/cc-blog/a-trace-tool-for-embedded-systems/), [RTT](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/), [CAN](https://en.wikipedia.org/wiki/CAN_bus), [LIN](https://en.wikipedia.org/wiki/Local_Interconnect_Network), ...
+  - This allowes also any other data path - method does'nt matter:\
+  [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter),\
+  [I²C](https://en.wikipedia.org/wiki/I%C2%B2C),\
+  [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface),\
+  [GPIO](https://circuitcellar.com/cc-blog/a-trace-tool-for-embedded-systems/),\
+  [RTT](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/),\
+  [CAN](https://en.wikipedia.org/wiki/CAN_bus),\
+  [LIN](https://en.wikipedia.org/wiki/Local_Interconnect_Network), ...