Swapping to clang-format

aws · Aug 3, 2023 · 7ead980 · 7ead980
1 parent a6684f9
commit 7ead980
Show file tree

Hide file tree

Showing 266 changed files with 2,595 additions and 2,583 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,65 +1,89 @@
 # Contributing Guidelines
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
-documentation, we greatly value feedback and contributions from our community.
-
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
-information to effectively respond to your bug report or contribution.
+Thank you for your interest in contributing to our project. Whether it's a bug
+report, new feature, correction, or additional documentation, we greatly value
+feedback and contributions from our community.
 
+Please read through this document before submitting any issues or pull requests
+to ensure we have all the necessary information to effectively respond to your
+bug report or contribution.
 
 ## Reporting Bugs/Feature Requests
 
-We welcome you to use the GitHub issue tracker to report bugs or suggest features.
-
-When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+We welcome you to use the GitHub issue tracker to report bugs or suggest
+features.
 
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
+When filing an issue, please check existing open, or recently closed, issues to
+make sure somebody else hasn't already reported the issue. Please try to include
+as much information as you can. Details like these are incredibly useful:
 
+- A reproducible test case or series of steps
+- The version of our code being used
+- Any modifications you've made relevant to the bug
+- Anything unusual about your environment or deployment
 
 ## Contributing via Pull Requests
-Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *main* branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
-4. The size of the PR is small. If the issue requires sizeable code change, you can go with the following:
-    * Break down the PR into independent components(that do not break the library functionality) and create separate PRs.
-    * Else, break down the changes into smaller commits and ensure you have a descriptive commit message.
-    * Provide a helpful description of the change.
+Contributions via pull requests are much appreciated. Before sending us a pull
+request, please ensure that:
+
+1. You are working against the latest source on the _main_ branch.
+2. You check existing open, and recently merged, pull requests to make sure
+   someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - we would hate for your
+   time to be wasted.
+4. The size of the PR is small. If the issue requires sizeable code change, you
+   can go with the following:
+   - Break down the PR into independent components(that do not break the library
+     functionality) and create separate PRs.
+   - Else, break down the changes into smaller commits and ensure you have a
+     descriptive commit message.
+   - Provide a helpful description of the change.
 
 To send us a pull request, please:
 
 1. Fork the repository.
-2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+2. Modify the source; please focus on the specific change you are contributing.
+   If you also reformat all the code, it will be hard for us to focus on your
+   change.
 3. Ensure local tests pass.
 4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+5. Send us a pull request, answering any default questions in the pull request
+   interface.
+6. Pay attention to any automated CI failures reported in the pull request, and
+   stay involved in the conversation.
 
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+GitHub provides additional document on
+[forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
-
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
 
+Looking at the existing issues is a great way to find something to contribute
+on. As our projects, by default, use the default GitHub issue labels
+(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any
+'help wanted' issues is a great place to start.
 
 ## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
 
+This project has adopted the
+[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For
+more information see the
+[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+[email protected] with any additional questions or comments.
 
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
+If you discover a potential security issue in this project we ask that you
+notify AWS/Amazon Security via our
+[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
+Please do **not** create a public github issue.
 
 ## Licensing
 
-See the [LICENSE](../LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](../LICENSE) file for our project's licensing. We will ask you
+to confirm the licensing of your contribution.
 
-We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
+We may ask you to sign a
+[Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement)
+for larger changes.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,37 +1,38 @@
 ---
 name: Bug report
-about: Create a report to help us improve AWS IoT Over-the-air Update library. Please
-       use this for confirmed bugs. If you suspect something it is best to first
-       discuss it on the FreeRTOS forums linked below.
+about:
+  Create a report to help us improve AWS IoT Over-the-air Update library. Please
+  use this for confirmed bugs. If you suspect something it is best to first
+  discuss it on the FreeRTOS forums linked below.
 title: "[BUG]"
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
-**Describe the bug**
-A concise description of what the bug is. If possible, that is the code is not proprietary, please upload the code in a [GitHub fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) such that we can reproduce the bug.
+**Describe the bug** A concise description of what the bug is. If possible, that
+is the code is not proprietary, please upload the code in a
+[GitHub fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
+such that we can reproduce the bug.
 
 **Host**
+
 - Host OS: [e.g. MacOS]
 - Version: [e.g. Mojave 10.14.6]
 
 **To Reproduce**
+
 - Use project ... and configure with ...
 - Run on ... and could observe ...
 
-**Expected behavior**
-A concise description of what you expected to happen.
+**Expected behavior** A concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots** If applicable, add screenshots to help explain your problem.
 
-**Wireshark logs**
-To help us identify the issue and/or reproduce it, please attach Wireshark logs if applicable.
+**Wireshark logs** To help us identify the issue and/or reproduce it, please
+attach Wireshark logs if applicable.
 
-**Additional context**
-Add any other context about the problem here.
-e.g. code snippet to reproduce the issue.
-e.g. stack trace, memory dump, debugger log, and many etc.
+**Additional context** Add any other context about the problem here. e.g. code
+snippet to reproduce the issue. e.g. stack trace, memory dump, debugger log, and
+many etc.
 
 <!-- For general inquiries, please post in [FreeRTOS forum](https://forums.FreeRTOS.org) for community support. -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,4 +2,6 @@ blank_issues_enabled: false
 contact_links:
   - name: FreeRTOS Community Support Forum
     url: https://forums.freertos.org/
-    about: Please ask and answer questions about AWS IoT Over-the-air Update Library here.
+    about:
+      Please ask and answer questions about AWS IoT Over-the-air Update Library
+      here.
diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md
@@ -2,21 +2,19 @@
 name: Documentation issue
 about: Create a report to help us improve our documentation.
 title: "[DOC] "
-labels: ''
-assignees: ''
-
+labels: ""
+assignees: ""
 ---
 
-**Describe the issue**
-Please describe the issue and expected clarification in concise language.
+**Describe the issue** Please describe the issue and expected clarification in
+concise language.
 
-**Reference**
-Please attach the URL at which you are experiencing the issue.
+**Reference** Please attach the URL at which you are experiencing the issue.
 
-**Screenshot**
-If applicable, please attach screenshot.
+**Screenshot** If applicable, please attach screenshot.
 
 **Browser**
+
 - Browser: [e.g. Chrome]
 - Version: [e.g. 80.0.3987.132]
 

diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -2,19 +2,18 @@
 name: Feature Request
 about: Suggest an idea for this project
 title: "[Feature Request] <replace with your title>"
-labels: ''
-assignees: ''
-
+labels: ""
+assignees: ""
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional context** Add any other context or screenshots about the feature
+request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,17 +1,18 @@
 <!--- Title -->
 
-Description
------------
+## Description
+
 <!--- Describe your changes in detail -->
 
-Checklist:
-----------
+## Checklist:
+
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
 <!--- Please refer to CONTRIBUTING.md for further guidelines -->
+
 - [ ] I have tested my changes. No regression in existing tests.
 - [ ] My code is formatted using Uncrustify.
-- [ ] I have read and applied the rules stated in CONTRIBUTING.md. 
-
+- [ ] I have read and applied the rules stated in CONTRIBUTING.md.
 
-By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
+By submitting this pull request, I confirm that you can use, modify, copy, and
+redistribute this contribution, under the terms of your choice.
diff --git a/.github/memory_statistics_config.json b/.github/memory_statistics_config.json
@@ -13,7 +13,5 @@
     "source/dependency/coreJSON/source/include",
     "source/dependency/3rdparty/tinycbor/src"
   ],
-  "compiler_flags": [
-    "OTA_DO_NOT_USE_CUSTOM_CONFIG"
-  ]
+  "compiler_flags": ["OTA_DO_NOT_USE_CUSTOM_CONFIG"]
 }
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -144,12 +144,12 @@ jobs:
       - name: Install Python3
         uses: actions/setup-python@v2
         with:
-          python-version: '3.11.0'
+          python-version: "3.11.0"
       - name: Measure sizes
         uses: Skptak/CI-CD-Github-Actions/memory_statistics@main
         with:
-            config: .github/memory_statistics_config.json
-            check_against: docs/doxygen/include/size_table.md
+          config: .github/memory_statistics_config.json
+          check_against: docs/doxygen/include/size_table.md
   proof_ci:
     if: ${{ github.event.pull_request }}
     runs-on: cbmc_ubuntu-latest_16-core

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,10 +4,10 @@ on:
   workflow_dispatch:
     inputs:
       commit_id:
-        description: 'Commit ID to tag and create a release for'
+        description: "Commit ID to tag and create a release for"
         required: true
       version_number:
-        description: 'Release Version Number (Eg, v1.0.0)'
+        description: "Release Version Number (Eg, v1.0.0)"
         required: true
 
 jobs:
@@ -24,7 +24,9 @@ jobs:
           git config --global user.name ${{ github.actor }}
           git config --global user.email ${{ github.actor }}@users.noreply.github.com
       - name: create a new branch that references commit id
-        run: git checkout -b ${{ github.event.inputs.version_number }} ${{ github.event.inputs.commit_id }}
+        run:
+          git checkout -b ${{ github.event.inputs.version_number }} ${{
+          github.event.inputs.commit_id }}
       - name: Generate SBOM
         uses: Skptak/CI-CD-Github-Actions/sbom-generator@main
         with:
@@ -93,8 +95,12 @@ jobs:
       - name: Create artifact of ZIP
         uses: actions/upload-artifact@v2
         with:
-          name: ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number }}.zip
-          path: zip-check/ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number }}.zip
+          name:
+            ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number
+            }}.zip
+          path:
+            zip-check/ota-for-aws-iot-embedded-sdk-${{
+            github.event.inputs.version_number }}.zip
   deploy-doxygen:
     needs: tag-commit
     name: Deploy doxygen documentation
@@ -120,20 +126,28 @@ jobs:
         with:
           tag_name: ${{ github.event.inputs.version_number }}
           release_name: ${{ github.event.inputs.version_number }}
-          body: Release ${{ github.event.inputs.version_number }} of AWS IoT Over-the-air Update Library.
+          body:
+            Release ${{ github.event.inputs.version_number }} of AWS IoT
+            Over-the-air Update Library.
           draft: false
           prerelease: false
       - name: Download ZIP artifact
         uses: actions/download-artifact@v2
         with:
-          name: ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number }}.zip
+          name:
+            ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number
+            }}.zip
       - name: Upload Release Asset
         id: upload-release-asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number }}.zip
-          asset_name: ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number }}.zip
+          asset_path:
+            ./ota-for-aws-iot-embedded-sdk-${{
+            github.event.inputs.version_number }}.zip
+          asset_name:
+            ota-for-aws-iot-embedded-sdk-${{ github.event.inputs.version_number
+            }}.zip
           asset_content_type: application/zip