FreeRTOS / FreeRTOS-Kernel

FreeRTOS kernel files only, submoduled into https://github.com/FreeRTOS/FreeRTOS and various other repos.
https://www.FreeRTOS.org
MIT License
2.76k stars 1.12k forks source link

Added the minimal example #823

Closed n9wxu closed 1 year ago

n9wxu commented 1 year ago

Description

minimal build example

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov[bot] commented 1 year ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (2be332a) 93.66% compared to head (c873de9) 93.66%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #823 +/- ## ======================================= Coverage 93.66% 93.66% ======================================= Files 6 6 Lines 2526 2526 Branches 604 604 ======================================= Hits 2366 2366 Misses 107 107 Partials 53 53 ``` | [Flag](https://app.codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/pull/823/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/pull/823/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS) | `93.66% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

n9wxu commented 1 year ago

/bot run formatting

Skptak commented 1 year ago

In general I am confused what the minimal_freertos_example/main.c file. To me it seems like an objectively worse version of the Posix_GCC/main.c, the WIN32-MSVC-Static-Allocation-Only, the WIN32-MSVC, or the WIN32-MingW main.c files?

n9wxu commented 1 year ago

/bot run formatting

amazonKamath commented 1 year ago

In general I am confused what the minimal_freertos_example/main.c file. To me it seems like an objectively worse version of the Posix_GCC/main.c, the WIN32-MSVC-Static-Allocation-Only, the WIN32-MSVC, or the WIN32-MingW main.c files?

I understand this is a minimal "build" example, than an example demonstrating functionality.

Skptak commented 1 year ago

In general I am confused what the minimal_freertos_example/main.c file. To me it seems like an objectively worse version of the Posix_GCC/main.c, the WIN32-MSVC-Static-Allocation-Only, the WIN32-MSVC, or the WIN32-MingW main.c files?

I understand this is a minimal "build" example, than an example demonstrating functionality.

But if it's a "minimal build example" it should be called that, or contain that information. This file directly states: /* This is a simple main that will start freertos and run a periodic task */

In my opinion, if the only reason this file exists is for static analysis it should probably just live in .github directory. If it's meant to be a true sample main.c file it should have info that would help a new user use it and turn it into an actual main.c file

Skptak commented 1 year ago

/bot run formatting

n9wxu commented 1 year ago

/bot run formatting

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information