Merge branch 'eclipse-cyclonedds:master' into expose-seqnum-via-sampl…

…einfo

.github/codeql/resolved-misra-rules.yml

@@ -0,0 +1,5 @@
+disable-default-queries: true
+
+# List of MISRA rules that have been resolved to check for regressions against.
+queries:
+  - uses: ./codeql-coding-standards/c/misra/src/rules/RULE-3-1/CharacterSequencesAndUsedWithinAComment.ql

.github/workflows/misra-regressions-check.yml

@@ -0,0 +1,86 @@
+# Check against the set of MISRA rules that have already been
+# resolved to prevent regressions.
+name: "MISRA regressions check"
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: ["master"]
+  schedule:
+    - cron: "16 12 * * 3"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: "ubuntu-latest"
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+        language: ["cpp"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Pull in the codeql-coding-standards qlpack repository.
+      # https://github.com/github/codeql-coding-standards
+      - name: Checkout codeql-coding-standards
+        uses: actions/checkout@v3
+        with:
+          repository: github/codeql-coding-standards
+          path: codeql-coding-standards/
+          ref: 39f8f9801307e058d6d9f07dcbe7c7d229c18dd0
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # Points at the config file containing the MISRA rules that have been resolved.
+          config-file: ./.github/codeql/resolved-misra-rules.yml
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          upload: False
+          output: sarif-results
+
+      - name: Filter Justified Results
+        uses: advanced-security/filter-sarif@v1
+        with:
+          patterns: |
+            # Description: Ignore files generated by Bison.
+            # Justification: Based on the rationale presented by MISRA:
+            #   - The comment occurs within the Bison skeleton files that have
+            #     been checked to not have a missing `*/` ending sequence and
+            #     whose source is not within a repository we maintain.
+            #   - The `//` within a block comment is not as a result of a region
+            #     of code being commented out, but rather as a result of a URL of
+            #     the form "https://..." being present in the comment.
+            #
+            # In addition, introducing infrastructure to remove this in-flight
+            # needlessly adds complexity.
+            -"**/src/idl/src/parser.{c,h}":c/misra/character-sequences-and-used-within-a-comment
+          input: sarif-results/cpp.sarif
+          output: sarif-results/cpp.sarif
+
+      - name: Upload SARIF
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: sarif-results/cpp.sarif
+          category: "MISRA"

docs/manual/config/config_file_reference.rst

@@ -714,7 +714,7 @@ The default value is: ``default``
 //CycloneDDS/Domain/Internal
 ============================
 
-Children: `//CycloneDDS/Domain/Internal/AccelerateRexmitBlockSize`_, `//CycloneDDS/Domain/Internal/AckDelay`_, `//CycloneDDS/Domain/Internal/AutoReschedNackDelay`_, `//CycloneDDS/Domain/Internal/BuiltinEndpointSet`_, `//CycloneDDS/Domain/Internal/BurstSize`_, `//CycloneDDS/Domain/Internal/ControlTopic`_, `//CycloneDDS/Domain/Internal/DefragReliableMaxSamples`_, `//CycloneDDS/Domain/Internal/DefragUnreliableMaxSamples`_, `//CycloneDDS/Domain/Internal/DeliveryQueueMaxSamples`_, `//CycloneDDS/Domain/Internal/EnableExpensiveChecks`_, `//CycloneDDS/Domain/Internal/GenerateKeyhash`_, `//CycloneDDS/Domain/Internal/HeartbeatInterval`_, `//CycloneDDS/Domain/Internal/LateAckMode`_, `//CycloneDDS/Domain/Internal/LivelinessMonitoring`_, `//CycloneDDS/Domain/Internal/MaxParticipants`_, `//CycloneDDS/Domain/Internal/MaxQueuedRexmitBytes`_, `//CycloneDDS/Domain/Internal/MaxQueuedRexmitMessages`_, `//CycloneDDS/Domain/Internal/MaxSampleSize`_, `//CycloneDDS/Domain/Internal/MeasureHbToAckLatency`_, `//CycloneDDS/Domain/Internal/MonitorPort`_, `//CycloneDDS/Domain/Internal/MultipleReceiveThreads`_, `//CycloneDDS/Domain/Internal/NackDelay`_, `//CycloneDDS/Domain/Internal/PreEmptiveAckDelay`_, `//CycloneDDS/Domain/Internal/PrimaryReorderMaxSamples`_, `//CycloneDDS/Domain/Internal/PrioritizeRetransmit`_, `//CycloneDDS/Domain/Internal/RediscoveryBlacklistDuration`_, `//CycloneDDS/Domain/Internal/RetransmitMerging`_, `//CycloneDDS/Domain/Internal/RetransmitMergingPeriod`_, `//CycloneDDS/Domain/Internal/RetryOnRejectBestEffort`_, `//CycloneDDS/Domain/Internal/SPDPResponseMaxDelay`_, `//CycloneDDS/Domain/Internal/SecondaryReorderMaxSamples`_, `//CycloneDDS/Domain/Internal/SocketReceiveBufferSize`_, `//CycloneDDS/Domain/Internal/SocketSendBufferSize`_, `//CycloneDDS/Domain/Internal/SquashParticipants`_, `//CycloneDDS/Domain/Internal/SynchronousDeliveryLatencyBound`_, `//CycloneDDS/Domain/Internal/SynchronousDeliveryPriorityThreshold`_, `//CycloneDDS/Domain/Internal/Test`_, `//CycloneDDS/Domain/Internal/UnicastResponseToSPDPMessages`_, `//CycloneDDS/Domain/Internal/UseMulticastIfMreqn`_, `//CycloneDDS/Domain/Internal/Watermarks`_, `//CycloneDDS/Domain/Internal/WriteBatch`_, `//CycloneDDS/Domain/Internal/WriterLingerDuration`_
+Children: `//CycloneDDS/Domain/Internal/AccelerateRexmitBlockSize`_, `//CycloneDDS/Domain/Internal/AckDelay`_, `//CycloneDDS/Domain/Internal/AutoReschedNackDelay`_, `//CycloneDDS/Domain/Internal/BuiltinEndpointSet`_, `//CycloneDDS/Domain/Internal/BurstSize`_, `//CycloneDDS/Domain/Internal/ControlTopic`_, `//CycloneDDS/Domain/Internal/DefragReliableMaxSamples`_, `//CycloneDDS/Domain/Internal/DefragUnreliableMaxSamples`_, `//CycloneDDS/Domain/Internal/DeliveryQueueMaxSamples`_, `//CycloneDDS/Domain/Internal/EnableExpensiveChecks`_, `//CycloneDDS/Domain/Internal/GenerateKeyhash`_, `//CycloneDDS/Domain/Internal/HeartbeatInterval`_, `//CycloneDDS/Domain/Internal/LateAckMode`_, `//CycloneDDS/Domain/Internal/LivelinessMonitoring`_, `//CycloneDDS/Domain/Internal/MaxParticipants`_, `//CycloneDDS/Domain/Internal/MaxQueuedRexmitBytes`_, `//CycloneDDS/Domain/Internal/MaxQueuedRexmitMessages`_, `//CycloneDDS/Domain/Internal/MaxSampleSize`_, `//CycloneDDS/Domain/Internal/MeasureHbToAckLatency`_, `//CycloneDDS/Domain/Internal/MonitorPort`_, `//CycloneDDS/Domain/Internal/MultipleReceiveThreads`_, `//CycloneDDS/Domain/Internal/NackDelay`_, `//CycloneDDS/Domain/Internal/PreEmptiveAckDelay`_, `//CycloneDDS/Domain/Internal/PrimaryReorderMaxSamples`_, `//CycloneDDS/Domain/Internal/PrioritizeRetransmit`_, `//CycloneDDS/Domain/Internal/RediscoveryBlacklistDuration`_, `//CycloneDDS/Domain/Internal/RetransmitMerging`_, `//CycloneDDS/Domain/Internal/RetransmitMergingPeriod`_, `//CycloneDDS/Domain/Internal/RetryOnRejectBestEffort`_, `//CycloneDDS/Domain/Internal/SPDPResponseMaxDelay`_, `//CycloneDDS/Domain/Internal/SecondaryReorderMaxSamples`_, `//CycloneDDS/Domain/Internal/SocketReceiveBufferSize`_, `//CycloneDDS/Domain/Internal/SocketSendBufferSize`_, `//CycloneDDS/Domain/Internal/SquashParticipants`_, `//CycloneDDS/Domain/Internal/SynchronousDeliveryLatencyBound`_, `//CycloneDDS/Domain/Internal/SynchronousDeliveryPriorityThreshold`_, `//CycloneDDS/Domain/Internal/Test`_, `//CycloneDDS/Domain/Internal/UnicastResponseToSPDPMessages`_, `//CycloneDDS/Domain/Internal/UseMulticastIfMreqn`_, `//CycloneDDS/Domain/Internal/Watermarks`_, `//CycloneDDS/Domain/Internal/WriterLingerDuration`_
 
 The Internal elements deal with a variety of settings that are evolving and that are not necessarily fully supported. For the majority of the Internal settings the functionality is supported, but the right to change the way the options control the functionality is reserved. This includes renaming or moving options.
 
@@ -1489,18 +1489,6 @@ The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (2^
 The default value is: ``1 kB``
 
 
-.. _`//CycloneDDS/Domain/Internal/WriteBatch`:
-
-//CycloneDDS/Domain/Internal/WriteBatch
----------------------------------------
-
-Boolean
-
-This element enables the batching of write operations. By default each write operation writes through the write cache and out onto the transport. Enabling write batching causes multiple small write operations to be aggregated within the write cache into a single larger write. This gives greater throughput at the expense of latency. Currently, there is no mechanism for the write cache to automatically flush itself, so that if write batching is enabled, the application may have to use the dds\_write\_flush function to ensure that all samples are written.
-
-The default value is: ``false``
-
-
 .. _`//CycloneDDS/Domain/Internal/WriterLingerDuration`:
 
 //CycloneDDS/Domain/Internal/WriterLingerDuration
@@ -2646,14 +2634,14 @@ The categorisation of tracing output is incomplete and hence most of the verbosi
 The default value is: ``none``
 
 ..
-   generated from ddsi_config.h[af204240792218d7541714019cac9ae65b87878f] 
-   generated from ddsi__cfgunits.h[be1b976c6e9466472b0c331487c05180ec1052d4] 
-   generated from ddsi__cfgelems.h[8090d347c12ef665e43b0de41fa57f309c4e9980] 
-   generated from ddsi_config.c[c8b22d1fe853f4cc6545b65610d441dee5558011] 
-   generated from _confgen.h[f2d235d5551cbf920a8a2962831dddeabd2856ac] 
-   generated from _confgen.c[d74e4fd06e485c5d299dbcc7741cbdb95c5ec706] 
-   generated from generate_rnc.c[a2ec6e48d33ac14a320c8ec3f320028a737920e0] 
-   generated from generate_md.c[37efe4fa9caf56e2647bafc9a7f009f72ff5d2e0] 
-   generated from generate_rst.c[50739f627792ef056e2b4feeb20fda4edfcef079] 
-   generated from generate_xsd.c[45064e8869b3c00573057d7c8f02d20f04b40e16] 
-   generated from generate_defconfig.c[ddf5057ceb5fb512b47f7028da2d75837a349830] 
+   generated from ddsi_config.h[7f55b8f40b2e7f5984106abb0470128eb3d50017] 
+   generated from ddsi__cfgunits.h[bd22f0c0ed210501d0ecd3b07c992eca549ef5aa] 
+   generated from ddsi__cfgelems.h[771184755c23b94599f2ffd6e8c242dcea7d2658] 
+   generated from ddsi_config.c[fec4d055c2154717183efd6610d46ea48236cdea] 
+   generated from _confgen.h[1b1d88a85bd851f4e87118505ded33f7b33b0435] 
+   generated from _confgen.c[237308acd53897a34e8c643e16e05a61d73ffd65] 
+   generated from generate_rnc.c[b50e4b7ab1d04b2bc1d361a0811247c337b74934] 
+   generated from generate_md.c[789b92e422631684352909cfb8bf43f6ceb16a01] 
+   generated from generate_rst.c[636ceeed42784e8508dd412b88dfd5f3b44b191b] 
+   generated from generate_xsd.c[6b6818d7f17a35d56c376c04ec1410427f34c0f0] 
+   generated from generate_defconfig.c[ee80ba6719e71a457a85f1a638fe52f3756916d5]