Update coverity example README (FreeRTOS#1020)

* Update coverity example README * Update main.c for comment --------- Co-authored-by: Ubuntu <ubuntu@ip-172-31-34-245.ap-northeast-1.compute.internal>
kstribrnAmzn · Apr 4, 2024 · ccbbf04 · ccbbf04
1 parent 52ee9fa
commit ccbbf04
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 21 deletions.
diff --git a/examples/cmake_example/main.c b/examples/cmake_example/main.c
@@ -43,7 +43,13 @@
 /* Standard includes. */
 #include <stdio.h>
 
-void exampleTask( void * parameters )
+/*-----------------------------------------------------------*/
+
+static void exampleTask( void * parameters );
+
+/*-----------------------------------------------------------*/
+
+static void exampleTask( void * parameters )
 {
     /* Unused parameters. */
     ( void ) parameters;
@@ -61,15 +67,15 @@ void main( void )
     static StaticTask_t exampleTaskTCB;
     static StackType_t exampleTaskStack[ configMINIMAL_STACK_SIZE ];
 
-    printf( "Example FreeRTOS Project\n" );
+    ( void ) printf( "Example FreeRTOS Project\n" );
 
-    xTaskCreateStatic( exampleTask,
-                       "example",
-                       configMINIMAL_STACK_SIZE,
-                       NULL,
-                       configMAX_PRIORITIES - 1,
-                       &( exampleTaskStack[ 0 ] ),
-                       &( exampleTaskTCB ) );
+    ( void ) xTaskCreateStatic( exampleTask,
+                                "example",
+                                configMINIMAL_STACK_SIZE,
+                                NULL,
+                                configMAX_PRIORITIES - 1U,
+                                &( exampleTaskStack[ 0 ] ),
+                                &( exampleTaskTCB ) );
 
     /* Start the scheduler. */
     vTaskStartScheduler();
@@ -81,12 +87,16 @@ void main( void )
 }
 /*-----------------------------------------------------------*/
 
-void vApplicationStackOverflowHook( TaskHandle_t xTask,
-                                    char * pcTaskName )
-{
-    /* Check pcTaskName for the name of the offending task,
-     * or pxCurrentTCB if pcTaskName has itself been corrupted. */
-    ( void ) xTask;
-    ( void ) pcTaskName;
-}
+#if ( configCHECK_FOR_STACK_OVERFLOW > 0 )
+
+    void vApplicationStackOverflowHook( TaskHandle_t xTask,
+                                        char * pcTaskName )
+    {
+        /* Check pcTaskName for the name of the offending task,
+         * or pxCurrentTCB if pcTaskName has itself been corrupted. */
+        ( void ) xTask;
+        ( void ) pcTaskName;
+    }
+
+#endif /* #if ( configCHECK_FOR_STACK_OVERFLOW > 0 ) */
 /*-----------------------------------------------------------*/
diff --git a/examples/coverity/README.md b/examples/coverity/README.md
@@ -4,7 +4,7 @@ run [Synopsys Coverity](https://www.synopsys.com/software-integrity/security-tes
 for checking MISRA compliance.
 
 > **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
 about type mismatch. We replace `pdTRUE` with `pdPASS` and `pdFALSE` with
 `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:
   ~~~
   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
    analysis:
   ~~~
-  cd cov-out/
   cov-analyze --dir ./cov-out \
     --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:
   ~~~