len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-04-19 21:11:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update coverity example README (#1020)

Browse source 
* Update coverity example README

* Update main.c for comment

---------

Co-authored-by: Ubuntu <ubuntu@ip-172-31-34-245.ap-northeast-1.compute.internal>
This commit is contained in:
chinglee-iot 2024-04-04 14:29:36 +08:00 committed by GitHub
parent 52ee9faa72
commit ccbbf04e5b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 30 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
examples/cmake_example/main.c
View file

@ -43,7 +43,13 @@
/* Standard includes. */ /* Standard includes. */
#include <stdio.h> #include <stdio.h>
void exampleTask( void * parameters ) /*-----------------------------------------------------------*/
static void exampleTask( void * parameters );
/*-----------------------------------------------------------*/
static void exampleTask( void * parameters )
{ {
/* Unused parameters. */ /* Unused parameters. */
( void ) parameters; ( void ) parameters;
@ -61,15 +67,15 @@ void main( void )
static StaticTask_t exampleTaskTCB; static StaticTask_t exampleTaskTCB;
static StackType_t exampleTaskStack[ configMINIMAL_STACK_SIZE ]; static StackType_t exampleTaskStack[ configMINIMAL_STACK_SIZE ];
printf( "Example FreeRTOS Project\n" ); ( void ) printf( "Example FreeRTOS Project\n" );
xTaskCreateStatic( exampleTask, ( void ) xTaskCreateStatic( exampleTask,
"example", "example",
configMINIMAL_STACK_SIZE, configMINIMAL_STACK_SIZE,
NULL, NULL,
configMAX_PRIORITIES - 1, configMAX_PRIORITIES - 1U,
&( exampleTaskStack[ 0 ] ), &( exampleTaskStack[ 0 ] ),
&( exampleTaskTCB ) ); &( exampleTaskTCB ) );
/* Start the scheduler. */ /* Start the scheduler. */
vTaskStartScheduler(); vTaskStartScheduler();
@ -81,12 +87,16 @@ void main( void )
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
void vApplicationStackOverflowHook( TaskHandle_t xTask, #if ( configCHECK_FOR_STACK_OVERFLOW > 0 )
char * pcTaskName )
{ void vApplicationStackOverflowHook( TaskHandle_t xTask,
/* Check pcTaskName for the name of the offending task, char * pcTaskName )
* or pxCurrentTCB if pcTaskName has itself been corrupted. */ {
( void ) xTask; /* Check pcTaskName for the name of the offending task,
( void ) pcTaskName; * or pxCurrentTCB if pcTaskName has itself been corrupted. */
} ( void ) xTask;
( void ) pcTaskName;
}
#endif /* #if ( configCHECK_FOR_STACK_OVERFLOW > 0 ) */
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/

7
examples/coverity/README.md
View file

@ -4,7 +4,7 @@ run [Synopsys Coverity](https://www.synopsys.com/software-integrity/security-tes
for checking MISRA compliance. for checking MISRA compliance.
> **Note** > **Note**
Coverity version 2022.6.1 incorrectly infers the type of `pdTRUE` and `pdFALSE` Coverity version 2023.6.1 incorrectly infers the type of `pdTRUE` and `pdFALSE`
as boolean because of their names, resulting in multiple false positive warnings as boolean because of their names, resulting in multiple false positive warnings
about type mismatch. We replace `pdTRUE` with `pdPASS` and `pdFALSE` with about type mismatch. We replace `pdTRUE` with `pdPASS` and `pdFALSE` with
`pdFAIL` to avoid these false positive warnings. This workaround will not be `pdFAIL` to avoid these false positive warnings. This workaround will not be
@ -40,15 +40,14 @@ commands in a terminal:
3. Build the (pseudo) application: 3. Build the (pseudo) application:
~~~ ~~~
cd build/ cd build/
cov-build --emit-complementary-info --dir cov-out make cov-build --emit-complementary-info --dir cov-out make coverity
~~~ ~~~
4. Go to the Coverity output directory (`cov-out`) and begin Coverity static 4. Go to the Coverity output directory (`cov-out`) and begin Coverity static
analysis: analysis:
~~~ ~~~
cd cov-out/
cov-analyze --dir ./cov-out \ cov-analyze --dir ./cov-out \
--coding-standard-config ../examples/coverity/coverity_misra.config \ --coding-standard-config ../examples/coverity/coverity_misra.config \
--tu-pattern "file('.*/FreeRTOS/Source/[A-Za-z_]*\.c') --tu-pattern "file('[A-Za-z_]+\.c')"
~~~ ~~~
5. Generate the HTML report: 5. Generate the HTML report:
~~~ ~~~