Merge pull request #1343 from nasa/integration-candidate

osal Integration candidate: Caelum-rc4+dev31

.github/workflows/build-osal-documentation.yml

@@ -32,7 +32,7 @@ jobs:
         run: sudo apt-get install doxygen graphviz -y
 
       - name: Checkout submodule
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up for build
         run: |
@@ -41,11 +41,11 @@ jobs:
 
       - name: Build OSAL API Guide
         run: |
-          make osal-apiguide > make_osal-apiguide_stdout.txt 2> make_osal-apiguide_stderr.txt
-          mv build/docs/osal-apiguide-warnings.log osal-apiguide-warnings.log          
+          make osal-apiguide 2>&1 > make_osal-apiguide_stdout.txt | tee make_osal-apiguide_stderr.txt
+          mv build/docs/osal-apiguide-warnings.log osal-apiguide-warnings.log
 
       - name: Archive Osal Guide Build Logs
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: OSAL Guide Artifacts
           path: |

.github/workflows/local_unit_test.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
 
 jobs:
-  #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. 
+  #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action.
   check-for-duplicates:
     runs-on: ubuntu-latest
     # Map a step output to a job output
@@ -30,7 +30,7 @@ jobs:
         run: sudo apt-get install lcov -y
 
       - name: Checkout submodule
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up for build
         run: |
@@ -44,9 +44,9 @@ jobs:
       - name: Test
         run: make test
 
-      - name: Calculate coverage 
+      - name: Calculate coverage
         run: make lcov | tee lcov_out.txt
- 
+
       - name: Confirm 100% line coverage
         run: |
           if [[ `grep -A 3 "Overall coverage rate" lcov_out.txt | grep lines` != *"100.0%"* ]]; then
@@ -63,7 +63,7 @@ jobs:
 
           diff=$(echo $coverage_nums | awk '{ print $4 - $3 }')
           if [ $diff -gt $missed_branches ]
-          then 
+          then
             grep -A 3 "Overall coverage rate" lcov_out.txt
             echo "More than $missed_branches branches missed"
             exit -1

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Development Build: v6.0.0-rc4+dev173
+- Update action versions
+- add doc-prebuild dependency
+- Update incorrect function header comment
+- See <https://github.com/nasa/osal/pull/1342>, <https://github.com/nasa/osal/pull/1341>, and <https://github.com/nasa/osal/pull/1321>
+
 ## Development Build: v6.0.0-rc4+dev165
 - Update CI to use Ubuntu 20.04
 - See <https://github.com/nasa/osal/pull/1334>

docs/src/CMakeLists.txt

@@ -68,17 +68,25 @@ endif ()
 # Generate the list of actual header files from the directories specified.  This is done
 # as a target that runs a separate script such that generator expressions can be evaluated.
 # This is done as a custom target such that it runs and gets updated every build
-add_custom_target(osal_public_api_headerlist 
+add_custom_command(OUTPUT "${CMAKE_BINARY_DIR}/docs/osal-public-api.doxyfile"
     COMMAND ${CMAKE_COMMAND}
         -DINCLUDE_DIRECTORIES="${OSAL_API_INCLUDE_DIRECTORIES}"
         -DCOMPILE_DEFINITIONS="${OSAL_API_COMPILE_DEFINITIONS}"
         -DINPUT_TEMPLATE="${CMAKE_CURRENT_SOURCE_DIR}/osal-public-api.doxyfile.in"
         -DOUTPUT_FILE="${CMAKE_BINARY_DIR}/docs/osal-public-api.doxyfile"
         -P "${CMAKE_CURRENT_SOURCE_DIR}/generate-public-api-doxyfile.cmake"
-    BYPRODUCTS "${CMAKE_BINARY_DIR}/docs/osal-public-api.doxyfile"
     WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
 )
 
+add_custom_target(osal_public_api_headerlist
+    DEPENDS "${CMAKE_BINARY_DIR}/docs/osal-public-api.doxyfile")
+
+# if building as part of CFS, then generate the doxygen header list as part of the prebuild step
+# The "doc-prebuild" target is defined by the CFS build, and thus will not exist if building standalone
+if (TARGET doc-prebuild)
+   add_dependencies(doc-prebuild osal_public_api_headerlist)
+endif ()
+
 file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide-warnings.log OSAL_NATIVE_LOGFILE)
 file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR}/docs/osal-common.doxyfile OSAL_NATIVE_COMMON_CFGFILE)
 file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/osal-apiguide.doxyfile OSAL_NATIVE_APIGUIDE_CFGFILE)

src/os/inc/osapi-version.h

@@ -34,7 +34,7 @@
 /*
  * Development Build Macro Definitions
  */
-#define OS_BUILD_NUMBER   165
+#define OS_BUILD_NUMBER   173
 #define OS_BUILD_BASELINE "v6.0.0-rc4"
 
 /*

src/os/portable/os-impl-bsd-sockets.c

@@ -365,8 +365,7 @@ int32 OS_SocketConnect_Impl(const OS_object_token_t *token, const OS_SockAddr_t
 
 /*----------------------------------------------------------------
 
-    Purpose: Connects the socket to a remote address.
-             Socket must be of the STREAM variety.
+    Purpose: Graceful shutdown of a stream socket
 
     Returns: OS_SUCCESS on success, or relevant error code
  ------------------------------------------------------------------*/